Web Services Reference for Oracle Billing Insight > RESTful API Resource Reference >

Web Service API Resources for Payments


You use the payment resources described in Table 17 to manage payment information in Oracle Billing Insight.

Table 17. API Resources for Payments
Operation
Resource URI
API Input Parameters
Description

GET

/payment/transactions

billingAccountid:{}, status:{2000, 2002, 2004, 2005}. Status values are from column ID of EDX_PMT_PAYMENT_STATUS_DEF table),
Optional: startDate and endDate. If the start date is empty, the default is 30 days prior to today's date.

Returns all payment transactions made for a given billing account, if provided. If billingAccountid is not provided, all payments viewable by the current user are returned.

POST

/payment/transactions

None.

Makes a payment for a given amount on the account using the existing specified payment account.

The billing account ID, payment account ID, and amount are in the payload and must be I18n compatible.

If payment account is null, the default payment account is used.

GET

/payment/transactions/
{paymentId}

None

Returns information about a particular payment. For credit card payments, only the last 4 digits of the card number are returned.

GET

/payment/transactions/external

None

Returns all external payment transactions made in an external system for a given billing account.

POST

/payment/transactions/external

None

Posts a payment transaction for a particular billing account, made externally, to Oracle Billing Insight.

GET

/payment/transactions/external/{trans_id}

None

Returns a payment transaction made in an external system.

PUT

/payment/transactions/external/{trans_id}

None

Updates a payment transaction made in an external system.

GET

/payment/recurringPmts

billingAccountid: {}

Returns a list of recurring payments created for a given billing account, if provided. If billingAccountid is not provided, all recurring payments created by the authenticated user are returned.

POST

/payment/recurringPmts

None

Create a recurring payment for a particular account. The billing account is included in the payload.

GET

/payment/recurringPmts/{recurringPmtId}

None

Returns a given recurring payment.

PUT

/payment/recurringPmts/{recurringPmtId}

None

Updates a given recurring payment.

DELETE

/payment/recurringPmts/{recurringPmtId}

None

Deletes a given recurring payment.

GET

/payment/pmtAccounts

None

Returns a list of payment accounts for the current authenticated user.

POST

/payment/pmtAccounts

None

Creates a payment account.

The payload includes accountType {bank, creditcard, debitcard}.

GET

/payment/pmtAccounts/{pmtAccountId}

None

Returns a payment account.

PUT

/payment/pmtAccounts/{pmtAccountId}

None

Updates a payment account.

DELETE

/payment/pmtAccounts/{pmtAccountId}

None

Deletes a payment account.

PUT

/payment/pmtAccounts/{pmtAccountId}/billingAccounts

None

Updates shared billing accounts.

PUT

/payment/pmtAccounts/defaultPmtAccount/{billingAcctId}/{pmtAccountId}

None

Updates the default payment account for a billing account.

GET

/payment/pmtAccounts/billingAccount/{billingAcctId}

None

Returns the payment accounts for a billing account.

Web Services Reference for Oracle Billing Insight Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.