Skip to main content

PayIDs

Use this resource to register, retrieve and deregister PayIDs.

Register

Use this resource to register a new PayID for an existing Customer.

Request

POST /customers/{customerId}/payids

Use your Secret API key to access this resource.

An example request for a Static PayID

{
  "payId": "customera@mydomain.com.au",
  "type": "STATIC",
  "supplierBusinessCode": "MYCOMPANY"
}

An example request for a Single-Use PayID that expects a specific payment amount.

{
  "payId": "customera@mydomain.com.au",
  "type": "SINGLE",
  "supplierBusinessCode": "MYCOMPANY",
  "paymentAmount": "10.00"
}

An example request for a Single-Use PayID that accepts any payment amount.

{
  "payId": "customera@mydomain.com.au",
  "type": "SINGLE",
  "supplierBusinessCode": "MYCOMPANY"
}
Path parameters
Parameter Name Format Description
customerId string QuickStream's unique identifier for the customer.
Request body
Field Format Description
payId string The email address to use as the PayID. The domain component of the email address must match one of those set up in your facility.
type string One of STATIC, SINGLE. See PayID Type.
supplierBusinessCode string The code that uniquely identifies your business.
paymentAmount string Send this field when type=SINGLE and you want the payment to match this amount exactly. If the payment does not match the amount, then the payment will be returned back to the payer automatically. To accept any payment amount, do not send this field

Response

If successful, this method returns a PayID Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
201 CREATED The request has succeeded and PayID was submitted for registration.
422 UNPROCESSABLE ENTITY The request body contained invalid data. Refer to errors in the response body for more. View more

Deregister

Use this resource to deregister a PayID. When a PayID is deregistered, it cannot be used to accept payments.

Request

PATCH /payids/{id}

Use your Secret API key to access this resource.

An example request to deregister a PayID.

{
  "status": "DEREGISTERED"
}
Path parameters
Parameter Name Format Description
id string QuickStream's unique identifier for a PayID.
Request body
Field Format Description
status string Set to DEREGISTERED.

Response

If successful, this method returns an HTTP 204 and no response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
204 NO CONTENT The request has succeeded and the PayID was submitted for deregistration.
404 NOT FOUND The PayID was not found by id.
422 UNPROCESSABLE ENTITY The request body contained invalid data or the PayID status is not REGISTERED. Refer to errors in the response body for more. View more

Get

Use this resource to get the details of a PayID.

Request

GET /payids/{id}

Use your Secret API key to access this resource.

Path parameters
Parameter Name Format Description
id string QuickStream's unique identifier for a PayID.
Request body

None.

Response

If successful, this method returns the PayID Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The PayID was not found by id.

List

Use this resource to list PayIDs for a Customer. Provide status to filter by the status of the PayID.

Request

GET /customers/{customerId}/payids

Use your Secret API key to access this resource.

Path parameters
Parameter Name Format Description
customerId string QuickStream's unique identifier for the customer.
Query parameters
Parameter Name Format Description
status string Optional. The status of the PayID. See PayID Status.
Request body

None.

Response

This is a paginated resource. The list is sorted to show the most recently registered accounts first.

Field Format Description
links Array of Links Links to related documents and resources.
data Array of PayID Model A paginated list of customer PayIDs.
HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The Customer was not found.

PayID Model

An example Static PayID response.

{
  "id": "f27371ce-0757-4767-aaf6-05ac7ce9dbe3",
  "payId": "customer@mydomain.com.au",
  "type": "STATIC",
  "supplierBusinessCode": "MYCOMPANY",
  "customerId": "87556623117",
  "status": "REGISTERED"
}

An example Single PayID response.

{
  "id": "f27371ce-0757-4767-aaf6-05ac7ce9dbe3",
  "payId": "customer@mydomain.com.au",
  "type": "SINGLE",
  "supplierBusinessCode": "MYCOMPANY",
  "customerId": "87556623117",
  "paymentAmount": {
      "currency": "AUD",
    "amount": 10.00,
    "displayAmount": "$10.00"
  },
  "status": "REGISTERED"
}
Field Format Description
id string A unique identifier for a PayID.
payId string The email address to be used as the PayID.
customerId string QuickStream's unique identifier for the customer.
type string The type of PayID.
supplierBusinessCode string The code that uniquely identifies your Business.
paymentAmount Money The ultimate Payee name.
status string The status of the PayID.
links Array of Links Links to related documents and resources.

PayID Status

State transition diagram for the PayID Status

Status Description
PENDING Pending registration.
REGISTERED Registered. Payments can be accepted by this PayID.
PENDING_DEREGISTRATION Pending deregistration.
DEREGISTERED Deregistered. Payments cannot be accepted by this PayID.
REJECTED Rejected during registration. PayID was not created.

PayID Type

Type Description
SINGLE A single-use PayID that accepts a single payment. Once a payment is received, the system deregisters the PayID.
When you provide a paymentAmount, the system will automatically return payments that do not match this amount exactly.
If no payment is received, you must deregister this PayID manually.
STATIC A static PayID that accepts many payments. You must deregister this PayID manually when it is no longer used.
If unexpected payments are received, you must refund those payments manually.
Westpac Privacy Statement

Privacy Statement (for individuals whose personal information may be collected - in this clause referred to as "you"). All personal information we collect about you is collected, used and disclosed by us in accordance with our Privacy Statement which is available at Privacy Statement or by calling us through your relationship manager or Westpac representative. Our Privacy Statement also provides information about how you can access and correct your personal information and make a complaint. You do not have to provide us with any personal information but, if you don't, we may not be able to process an application or a request for a product or service.