Cancel Bill Payment

post

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

Use the Cancel Bill Payment endpoint to cancel the following types of billpay transactions:

Paper transactions in status N, W or P.
Electronic (RPPS) transactions in status N
Non-recurring paper or electronic transactions that are scheduled for a future date

If the transaction is in another status, the endpoint returns status_code: 435-02See Managing Billpay Transactions for 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
435-01	Bill pay transaction could not be found
435-02	Bill pay transaction not in a reversible state

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"

billpayTransactionId

int32

required

0 to 1000000000000000000

The billpay transaction ID (billpay_transaction_id) as returned by the Create Bill Payment or Get Bill Payment History endpoint.
Pattern: Positive integer
Example: 3433443

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

Status codes

default