Modify RPPS Biller

post

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

Use the Modify RPPS Biller endpoint to update an RPPS 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.

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
581-01	amount, nextDate, and endDate are required for scheduled bill payment
581-02	Biller not associated to account
581-03	Biller not found
581-04	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"

billerId

int32

required

Identifier for the biller (biller_id) as returned by the Add RPPS Biller or Get Billers endpoint. Do not use the rpps_biller_id from Search Biller Directory.
Pattern: Integer
Example: 2982

frequencyType

string | null

enum

required

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

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