Get AutoPay Plan

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getAutoPayPlan

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

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
639-07	Account not found

Form Data

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

length between 1 and 60

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 | null

An optional provider-generated timestamp for the API request.
Pattern: 1–60 characters
Example: "47823438032233777"

providerTransactionId

string | null

An optional provider-generated ID for the API request.
Pattern: 1–60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

^([0-9]{12})$

PRN of the credit account.
Pattern: 12-digit numerical string
Example: "074103447228"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Status codes

default