List the retry cycle history for an account

GET

https://payment-retry.apps.zuora.com/api/v1/payments/account_cycle_history/:account_id

GET

/api/v1/payments/account_cycle_history/:account_id

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.configurable_payment_retry.get_account_cycle_history(
    account_id="account_id",
)

200Retrieved

{
  "cycles": [
    {
      "account_id": "2c92c0f96bd69165016bdcbf55ad5e62",
      "invoice_id": "2c92c0fa7849b3ff01784bc5e8ee18b5",
      "payment_method_id": "2c92c0f9774f2b3e01775f6cf2fb726a",
      "currency": "USD",
      "status": "Cycle Complete",
      "current_attempt_number": 3,
      "next_attempt": "2021-03-19T18:53:39.641Z",
      "customer_group": "All Remaining Customers",
      "attempts": [
        {
          "attempt_number": 1,
          "zuora_payment_id": "2c92c0867849d42301784bc9ce806c31",
          "time_of_execution": "2021-03-19T18:42:20.103Z",
          "source": "PR-00000371",
          "cpr_generated": false,
          "success": false,
          "amount_collected": 0,
          "action_info": {
            "action": "Retry"
          },
          "retry_info": {
            "next": "2021-03-19T09:43:28.670-09:00",
            "criteria": "incremental_time"
          },
          "mapping_info": {
            "label": "Hard Decline",
            "level": "code",
            "customer_group_id": 1
          },
          "gateway_info": {
            "id": "2c92c0f85e2d19af015e3a61d8947e5d",
            "code": "insufficient_funds",
            "response": "Your card has insufficient funds."
          }
        },
        {
          "attempt_number": 2,
          "zuora_payment_id": "2c92c09c7849d3c101784bcdfc010671",
          "time_of_execution": "2021-03-19T18:52:24.137Z",
          "source": "PR-00000372",
          "cpr_generated": true,
          "success": false,
          "amount_collected": 0,
          "action_info": {
            "action": "Stop"
          },
          "retry_info": {},
          "mapping_info": {
            "label": "Hard Decline",
            "level": "code",
            "customer_group_id": 1
          },
          "gateway_info": {
            "id": "2c92c0f85e2d19af015e3a61d8947e5d",
            "code": "insufficient_funds",
            "response": "Your card has insufficient funds."
          }
        }
      ]
    },
    {
      "account_id": "2c92c0f96bd69165016bdcbf55ad5e62",
      "invoice_id": "2c92c0fb78532b0f01785a38cede190a",
      "payment_method_id": "2c92c0f9774f2b3e01775f6cf2fb726a",
      "currency": "USD",
      "status": "Cycle Incomplete",
      "current_attempt_number": 1,
      "next_attempt": "2021-03-24T19:34:20.254Z",
      "customer_group": "All Remaining Customers",
      "attempts": [
        {
          "attempt_number": 1,
          "zuora_payment_id": "2c92c085785305e201785a51aae41969",
          "time_of_execution": "2021-03-23T16:50:18.878Z",
          "source": "PR-00000376",
          "cpr_generated": false,
          "success": false,
          "amount_collected": 0,
          "action_info": {
            "action": "Retry"
          },
          "retry_info": {
            "next": "2021-03-23T07:51:30.316-09:00",
            "criteria": "incremental_time"
          },
          "mapping_info": {
            "label": "Hard Decline",
            "level": "code",
            "customer_group_id": 1
          },
          "gateway_info": {
            "id": "2c92c0f85e2d19af015e3a61d8947e5d",
            "code": "insufficient_funds",
            "response": "Your card has insufficient funds."
          }
        }
      ]
    }
  ]
}

Gets information of all retry cycles for an account in Configurable Payment Retry.

Authentication

AuthorizationBasic

The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.

Path parameters

account_idstringRequired

ID of an account.

Response

cycleslist of objectsOptional

An array containing information of all completed retry cycles for an account. See the example for details.