1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Payment Method Management

Get Payment Methods

get

/paymentMethod

Gets the payment methods that match the query criteria.

Request

Query Parameters
  • The Business Identifier Code of a bank (for retrieving bankAccountDebit payment methods).
    Examples

  • The account number (for retrieving bankAccountDebit payment methods).
    Examples

  • The name of a bank (for retrieving bankAccountDebit payment methods).
    Examples

  • The card number (for retrieving bankCard payment methods).
    Examples

  • The name on the card (for retrieving bankCard payment methods). You can use bankCard.nameOnCard.like= to get partial matches.
    Examples

  • The type of bank card (for retrieving bankCard payment methods). The only valid value for BRM is CREDIT.
    Examples

  • The list of comma-separated fields to return in the response.
    Examples

  • The name on the invoice (for retrieving invoice payment methods). You can use invoice.name.like= to get partial matches.
    Examples

  • The maximum number of results to return.
    Examples

  • The name of the payment method instance.
    Examples

  • The number of results to offset the response by.
    Examples

  • The ID of a related party to get payment methods for.
    Examples

  • The type of related party to get payment methods for.
  • The type of payment method to get: tokenizedCard, invoice, bankAccountDebit, or bankCard.
    Examples

    Allowed Values: [ "tokenizedCard", "bankAccountDebit", "bankCard", "invoice" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The payment methods were returned successfully.
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : PaymentMethodType
Type: object
A payment method.
Show Source
Nested Schema : account
Type: array
An account that owns or can use the payment method.
Show Source
Nested Schema : details
Type: object
The payment method's details, which differ based on the @type property.
Nested Schema : relatedParty
Type: array
The related party that owns the payment method.
Show Source
Nested Schema : TimePeriodType
Type: object
A period of time.
Show Source
Nested Schema : AccountRefType
Type: object
An account reference.
Show Source
Nested Schema : RelatedPartyRefType
Type: object
A related party.
Show Source

400 Response

The request isn't valid.

401 Response

The client doesn't have the correct privileges.

403 Response

The request wasn't authorized.

405 Response

This method is not allowed.

500 Response

The system encountered an internal error.
Back to Top

Examples

The following example shows how to get a list of no more than two bankAccountDebit payment methods at the My Bank bank by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET 'http://host:port/brm/paymentMethods/version/paymentMethod?type=bankAccountDebit&limit=2'

Example of the Response Body

The following example shows the contents of the response body in JSON format. Because of the query criteria, only two debit accounts are shown. 

[
   {
      "id": "0.0.0.1+-payinfo-dd+240947",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-dd+240947",
      "name": "Mary Robbin's Direct Debit Account",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "0.0.0.1+-account+244543",
            "href": null,
            "description": "Mary's Primary Account",
            "name": "Mary Robbins",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
         }
      ],
      "preferred": true,
      "relatedParty": null,
      "@type": "bankAccountDebit",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "accountNumber": "12341234123412341",
         "accountNumberType": "Savings",
         "BIC": "111122334",
         "owner": "Mary Robbins",
         "bank": "My Bank"
      }
   },
   {
      "id": "0.0.0.1+-payinfo-dd+249648",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-dd+249648",
      "name": "Adam Baker's Direct Debit Account",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "0.0.0.1+-account+104221",
            "href": null,
            "description": "Grace's Primary Account",
            "name": "Adam Baker",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
         }
      ],
      "preferred": true,
      "relatedParty": null,
      "@type": "bankAccountDebit",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "accountNumber": "12345678901236491",
         "accountNumberType": "Savings",
         "BIC": "111122334",
         "owner": "Adam Baker",
         "bank": "My Bank"
      }
   }
]
Back to Top