---
title: "Get AutoPay Plan"
method: POST
path: "/getAutoPayPlan"
tags: ["Credit"]
---

# Get AutoPay Plan

`POST /getAutoPayPlan`

## Request

- Base URL: `api-{corename}.{env}.gpsrv.com/intserv/4.0/` (relative, and the document’s source URL is not known)
- URL: `api-{corename}.{env}.gpsrv.com/intserv/4.0/getAutoPayPlan`
- Auth: none declared

Use the Get AutoPay Plan endpoint to retrieve the current autopay configuration and the next scheduled execution date for a credit account.

## Request body `application/x-www-form-urlencoded`

- object
  - `apiLogin` string, required: Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: `"AbC123-9999"`
  - `apiTransKey` string, required: Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`
  - `providerId` integer, required: System-generated provider identifier. Pattern: Max 10 digits Example: `9999`
  - `transactionId` string, required: A unique provider-generated ID to identify this API call. A UUID is preferred. Pattern: 60 characters or less Example: `"9845dk-39fdk3fj3-4483483478"`
  - `providerTimestamp` string, nullable: An optional provider-generated timestamp for the API request. Pattern: 1–60 characters Example: `"47823438032233777"`
  - `providerTransactionId` string, nullable: An optional provider-generated ID for the API request. Pattern: 1–60 characters Example: `"9845dk-39fdk3fj3-4483483478"`
  - `accountNo` string, required: <<glossary:PRN>> of the credit account. Pattern: 12-digit numerical string Example: `"074103447228"`

## Response `default`

- object
  - `status_code` integer, nullable, required: The response status code. May return a string for some statuses.
  - `status` string, nullable, required: The condition of a process or response
  - `processing_time` number, nullable, required: The time elapsed in processing the transaction
  - `echo` union, required: A structure that contains transaction ID information
    - object
      - `transaction_id` string, nullable, required: An ID that represents an API transaction
      - `provider_timestamp` string, nullable, required: Store a related timestamp for reporting and troubleshooting purposes
      - `provider_transaction_id` string, nullable, required: Secondary transaction identifier (generated by a provider)
    - object, nullable
  - `system_timestamp` string, date-time, nullable, required: A system generated timestamp
  - `rtoken` string, nullable, required: A system-generated ID used for tracking
  - `errors` string[]: A list of errors generated while the request was processed
  - `response_data` object
    - `autopay_plan` object
      - `autopayStatus` string, nullable, required: Current autopay status. Possible values: `enabled`, `disabled`.
      - `fromAccountNo` string, nullable, required: The account funds are drawn from for autopay.
      - `startDate` string, nullable, required: The configured autopay start date. Format: YYYY-MM-DD. Null when autopay is disabled.
      - `nextExecutionDate` string, nullable, required: The next scheduled autopay execution date. Format: YYYY-MM-DD. Null when autopay is disabled or no schedule state exists.

## Changes

- **2026-11-03** `1ede7567a879`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/galileo-ft/apis/program-api/changes/getAutoPayPlan/post.md)

---

[API](https://skmtc.dev/galileo-ft/apis/program-api.md) - [All operations](https://skmtc.dev/galileo-ft/apis/program-api/llms.txt) - [OpenAPI document](https://skmtc.dev/galileo-ft/apis/program-api/revisions/1ede7567a879?raw)