Transactions

Add Paper Biller

Use the Add Paper Biller endpoint to create a custom paper biller for a customer and to schedule paper bill payments. Billers that are created with this endpoint will receive a paper check instead of an electronic payment.

The account must be active (status: N) to use this endpoint. See <a href="doc:creating-a-billpay-transaction" target="_blank">Creating a Billpay Transaction</a> for further instructions on using this endpoint.

post/addPaperBiller

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/addPaperBiller
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"

billerNamestring required

Display name for the biller. You can have duplicate billerNames as long as the addresses are different. Pattern: Max 50 alphanumeric characters, no punctuation Example: "My Landlord"

billerAddress1string required

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

billerAddress2string nullable

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

billerCitystring required

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' required

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

billerZipstring required

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"

billerAccountNostring required

Account number that the account holder has with the biller. This value is not validated against a formatting mask. If there is no account number for the biller, pass n/a. You cannot edit this value with <a href="ref:post_modifypaperbiller" target="_blank">Modify Paper Biller</a>. If the account holder submits an incorrect value, you must remove the biller and create the biller again with the correct account number. Pattern: Alphanumeric string including hyphens and spaces. Example: "3333223323455555"

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

Example request

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

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.