Octane REST API
  1. Payment Method
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
        GET
      • Add Payment Method
        POST
      • Update Payment Method
        PATCH
      • Delete Payment Method
        DELETE
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Payment Method

Update Payment Method

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
PATCH
https://benzine.telcoinabox.com/tiab/api
/v1/group/{groupNo}/customer/{custNo}/payment-method/{paymentId}
This API will be used to update an existing payment method on a Customer account. User can update Expiry Date and Cardholder Name for CC Accounts, or Account Name for a DD account.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params

Body Params application/json

Example
{
    "cardHolderName": "string",
    "cardExpiryDateMonth": "string",
    "cardExpiryDateYear": "string",
    "bankAccountName": "string",
    "isDefault": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://benzine.telcoinabox.com/tiab/api/v1/group/123/customer/554433/payment-method/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "cardHolderName": "string",
    "cardExpiryDateMonth": "string",
    "cardExpiryDateYear": "string",
    "bankAccountName": "string",
    "isDefault": true
}'

Responses

🟢200OK
application/json
Body

Example
{
    "customerId": "string",
    "paymentId": "string",
    "paymentType": "CREDIT_CARD",
    "isDefault": true,
    "currency": "AUD",
    "cardNumber": "string",
    "cardHolderName": "string",
    "cardExpiryDateMonth": "string",
    "cardExpiryDateYear": "string",
    "cardScheme": "MASTERCARD",
    "maskedCardNumber4Digits": "string",
    "panType": "FPAN",
    "bsb": "string",
    "bankDisplayName": "string",
    "bankAccountName": "string",
    "bankAccountNumber": "string"
}
🟠404Customer not found
🟠403Invalid access
Modified at 2024-04-16 05:46:26
Previous
Add Payment Method
Next
Delete Payment Method
Built with