Transactions

Modify Paper Biller

Use the Modify Paper Biller endpoint to update a paper biller. All non-required fields are nullifiable. To cancel a scheduled series, either set endDate to the current date or pass Null for frequencyType, nextDate and endDate. The account must be active (status: N) to use this endpoint.

post/modifyPaperBiller

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/modifyPaperBiller
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

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

billerIdinteger required

Identifier for the biller (biller_id) as returned by the <a href="ref:post_addpaperbiller" target="_blank">Add Paper Biller</a> or <a href="ref:post_getbillers" target="_blank">Get Billers</a> endpoint. Pattern: Integer Example: 2982

frequencyType'O' | 'W' | 'M' | 'Q' | 'Y' nullable

Frequency of the bill payment:

O — One time
W — Weekly
M — Monthly
Q — Quarterly
Y — Yearly

If this value is not O then nextDate and endDate are required. Pattern: One letter Example: "W"

nextDatestring date-time nullable

The next date that the payment is scheduled. Pattern: YYYY-MM-DD Example: "2015-02-04"

endDatestring date-time nullable

The last date that the payment is scheduled. Can be up to five years in the future, so if today is 20 Jan 2020, this parameter can be no later than 20 Jan 2025. However, if today's date is a leap day, such as 29 Feb 2020, the latest date can be 1 Mar 2025. Pattern: YYYY-MM-DD Example: "2015-02-04"

amountnumber float nullable

Currency amount as a whole or decimal amount. Pattern: Positive integer or decimal number Example: 100.00, 100, or 100.73

billerAddress1string nullable

First line of the biller address. Pattern: Max 80 alphanumeric characters Example: "33 Maple Street"

billerAddress2string nullable

Second line of biller address. Pattern: Max 30 alphanumeric characters Example: "#4B"

billerCitystring nullable

Biller city. Pattern: Max 30 letters and spaces Example: "Salt Lake City"

billerState'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AE' | 'AP' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT' nullable

Biller state or province. Pattern: 2-character state or provincial abbreviation Example: "UT"

billerZipstring nullable

Biller postal code. Pattern: 12345, 12345-1234, or K1A-1A1 Example: "84121"

billerPhonestring nullable

Biller phone number or "null". Pattern: Exactly 10 digits, no hyphens or other characters or "null" Example: "8013656060"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "billerId": 2982,
  "frequencyType": "W",
  "nextDate": "2015-02-04",
  "endDate": "2015-02-04",
  "amount": 25.5,
  "billerAddress1": "33 Maple Street",
  "billerAddress2": "#4B",
  "billerCity": "Salt Lake City",
  "billerState": "UT",
  "billerZip": "84121",
  "billerPhone": "8013656060"
}

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

Changes

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