Set AutoPay Plan

post

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

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 and fromAccountNo must refer to different accounts.

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
629-01	Cannot disable autopay: account has no active autopay enrollment
629-02	A payment execution is currently in flight for this account
629-03	A failed payment is awaiting retry for this account

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

integer

required

Galileo-issued 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"

fromAccountNo

string

required

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

accountNo

string

required

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

startDate

string | null

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

enum

required

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

Allowed:

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

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default