Add Paper Biller

post

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

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 Creating a Billpay Transaction for further instructions on using this endpoint.

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
487-01	Customer already has this biller
487-04	amount, nextDate, and endDate are required for scheduled bill payment
487-05	Account not active

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

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

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

accountNo

string

required

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

billerName

string

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"

billerAddress1

string

required

length between 3 and 80

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

billerAddress2

string | null

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

billerCity

string

required

length between 1 and 60

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

billerState

string

enum

required

length between 2 and 2

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

billerZip

string

required

length between 5 and 10

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

billerPhone

string | null

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

billerAccountNo

string

required

length between 1 and 30

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 Modify Paper Biller. 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

string | null

enum

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"

Allowed:

nextDate

date-time | null

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

endDate

date-time | null

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"

amount

float | null

0.01 to 999999999999.99

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

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

Response

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

application/json

application/xml

Status codes

default