Create Bill Payment

post

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

Use the Create Bill Payment endpoint to create a bill payment transaction. Before you can use this endpoint, you must create the biller.

The account must be active (status: N) to use this endpoint. See Creating a Billpay Transaction for further instructions on using this endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

^$|^([0-9]{12}|[0-9]{16})$

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

amount

float

required

≥ 0.01

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

billerId

int32

required

≥ 1

Identifier for the biller (biller_id) as returned by the Add RPPS Biller, Add Paper Biller or Get Billers endpoint.
Pattern: Positive integer
Example: 37323

processDate

date | null

Date in the future to process the payment. Leave blank to process the payment immediately.
Pattern: YYYY-MM-DD
Example: 2025-01-01

memo

string | null

^[A-Za-z0-9|_. '?,!@$%#"-=~]

String to print in the memo field of printed paper checks.
Pattern: Max 50 alphanumeric characters including punctuation
Example: For babysitting

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

default