GAgalileo-ft
Credit

Set AutoPay Attempt

Use the Set AutoPay Attempt endpoint to specify the number and frequency of retries in the case of client error.

post/setAutoPayAttempt

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/setAutoPayAttempt
  • 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"

retryAttemptsinteger required

Number of times the system will retry an automated payment in case of client error. Pattern: Integer 0–4 Example: 3

retryIntervalinteger required

Number of days between retry attempts. Pattern: Integer 1–7 Example: 1

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "9845dk-39fdk3fj3-4483483478",
  "retryAttempts": 3,
  "retryInterval": 1
}

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.