Update PayID status

Path Params
string
required

PayID

Body Params
string
enum
required

Updated PayID status. Possible values:

  • ACTIVE: Activate PayID to allow it to be used
  • DISABLED: Disable PayID and prevent it from being used or transferred
  • DEREGISTERED: De-register PayID from current Account
  • PORTABLE: Place PayID in transferable state allowing it to be registered to a different Account while still being used
Allowed:
string
enum
required

PayID type:

  • EMAIL: Email Address
  • INDIVIDUAL_AUSTRALIAN_BUSINESS: Australian business identifier
  • ORGANISATION: Organisation identifier
  • TELEPHONE: Telephone number
Allowed:
string
enum

Reason for current PayID status. Possible values: CUST: Customer initiated DECD: Customer deceased FROD: Fraud suspected LEGL: Legal reasons PART: NPP participant initiated

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json