GAgalileo-ft
Credit

Set AutoPay Plan

Use the Set AutoPay Plan endpoint to configure or update autopay for a credit account. When enabling autopay, both accountNo and fromAccountNo are validated to confirm they exist and are active before enrollment. accountNo must be the primary credit account (authorized users / secondaries are rejected). accountNo and fromAccountNo must refer to different accounts.

post/setAutoPayPlan

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/setAutoPayPlan
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

System-generated provider identifier. Pattern: Max 10 digits Example: 9999

transactionIdstring required

A unique provider-generated ID to identify this API call. A UUID is preferred. Pattern: 60 characters or less Example: "9845dk-39fdk3fj3-4483483478"

providerTimestampstring nullable

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

providerTransactionIdstring nullable

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

fromAccountNostring required

<glossary:PRN> of the debit account. Pattern: 12-digit numerical string Account must exist and be active when enabling autopay. Example: "074103447228"

accountNostring required

<glossary:PRN> of the credit account. Pattern: 12-digit numerical string Account must exist and be active when enabling autopay. Example: "074103447228"

startDatestring nullable

The date of the first automated payment in ISO 8601 format (YYYY-MM-DD). Date must be between one day and one month from today must be between one day and when autopayStatus is enabled. Ignored when autopayStatus is disabled. Pattern: YYYY-MM-DD Example: "2026-04-15"

autopayStatus'enabled' | 'disabled' required

Whether autopay is to be enabled or disabled. Pattern: enabled or disabled Example: "enabled"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "9845dk-39fdk3fj3-4483483478",
  "fromAccountNo": "074103447228",
  "accountNo": "074103447228",
  "startDate": "2026-04-15",
  "autopayStatus": "enabled"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data.This endpoint does not return response data, so it will always be empty.

Changes

No recorded changes to this operation across all 2 revisions of this API.