List Pix Automático Charges by Authorization

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "items": [
    {
      "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "amount": "29.90",
      "attemptCount": 1,
      "attempts": [
        {
          "attemptedAt": "2023-11-07T05:31:56Z",
          "dayIndex": 0,
          "endToEndId": "E30306294202606241200abcdef00001",
          "failureCode": "DEBIT_FAILED",
          "failureMessage": "The debit attempt could not be completed.",
          "outcome": "EXECUTED",
          "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
          "scheduledFor": "2026-04-24T03:00:00Z"
        }
      ],
      "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "currentDayIndex": 0,
      "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "dueDate": "2026-04-25",
      "executedAt": "2023-11-07T05:31:56Z",
      "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
      "failedAt": "2023-11-07T05:31:56Z",
      "failureCode": "CHARGE_REJECTED",
      "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "journey": "J4",
      "maxAttempts": 4,
      "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "status": "SCHEDULED",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

GET

recurrences

payer

authorizations

{authorizationId}

charges

List Pix Automático Charges by Authorization

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{authorizationId}/charges"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

{
  "items": [
    {
      "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "amount": "29.90",
      "attemptCount": 1,
      "attempts": [
        {
          "attemptedAt": "2023-11-07T05:31:56Z",
          "dayIndex": 0,
          "endToEndId": "E30306294202606241200abcdef00001",
          "failureCode": "DEBIT_FAILED",
          "failureMessage": "The debit attempt could not be completed.",
          "outcome": "EXECUTED",
          "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
          "scheduledFor": "2026-04-24T03:00:00Z"
        }
      ],
      "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "currentDayIndex": 0,
      "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "dueDate": "2026-04-25",
      "executedAt": "2023-11-07T05:31:56Z",
      "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
      "failedAt": "2023-11-07T05:31:56Z",
      "failureCode": "CHARGE_REJECTED",
      "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "journey": "J4",
      "maxAttempts": 4,
      "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "status": "SCHEDULED",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id

string

required

Unique identifier of the Midaz Ledger Account (UUID format).

Path Parameters

authorizationId

string

required

Authorization ID (UUID format)

Query Parameters

limit

integer

default:10

Maximum number of items per page.

Required range: 1 <= x <= 100

page

integer

default:1

Page number for pagination.

Required range: x >= 1

status

enum<string>

Filter by status

Available options:

RECEIVED,

SCHEDULED,

EXECUTED,

FAILED,

CANCELLED

start_date

string<date-time>

ISO 8601 UTC lower bound on createdAt

end_date

string<date-time>

ISO 8601 UTC upper bound on createdAt

sort_order

enum<string>

default:asc

Sort direction: asc or desc.

Available options:

asc,

desc

Response

items

object[]

Show child attributes

limit

integer

Example:

10

page

integer

Example:

1

total

integer

Example:

42

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Webhooks API

Error handling

List Pix Automático Charges by Authorization

Authorizations

Headers

Path Parameters

Query Parameters

Response