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

Get Payment Methods for an Account

get

/accounts/{accountId}/paymentMethods

Gets the payment methods associated with the specified account.

Request

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

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

  • The card number (for retrieving bankCard payment methods).
  • 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.
  • 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 type of payment methods to get: tokenizedCard, bankAccountDebit, bankCard, or invoice.
    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 for the account 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

Example 1: Get Payment Methods by Account ID

The following example shows how to get all payment methods for a specified account ID 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/accounts/0.0.0.1+-account+244543/paymentMethods'

Example of the Response Body

The following example shows the contents of the response body in JSON format. Note that the account has three different types of payment methods, resulting in different properties under the details property. 

[
   {
      "id": "0.0.0.1+-payinfo-cc+238991",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethods/0.0.0.1+-payinfo-cc+238991",
      "name": "Mark's Tokenized Card",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "0.0.0.1+-account244543",
            "href": null,
            "description": "Mark's primary account"
            "name": "Mark Evans",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
         }
      ],
      "preferred": false,
      "relatedParty": null,
      "@type": "tokenizedCard",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "brand": "Visa",
         "type": "CREDIT",
         "lastFourDigits": "1111",
         "tokenType": "1",
         "token": "4111111111111111",
         "issuer": null
      }
   },
   {
      "id": "0.0.0.1+-payinfo-cc+286527",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethods/0.0.0.1+-payinfo-cc+286527",
      "name": "Mark's Bank Card",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "0.0.0.1+-account244543",
            "href": null,
            "description": "Mark's primary account"
            "name": "Mark Evans",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
         }
      ],
      "preferred": false,
      "relatedParty": null,
      "@type": "bankCard",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "brand": "VISA",
         "type": "CREDIT",
         "cardNumber": "4222222222222"
         "expirationDate": "2025-02-28T11:59:59+05:30",
         "cvv": null,
         "lastFourDigits": "2222",
         "nameOnCard": "Mark Evans",
         "bank": null
      }
   },
   {
      "id": "0.0.0.1+-payinfo-dd+240947",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-dd+240947",
      "name": "Mark's Direct Debit Account",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "0.0.0.1+-account244543",
            "href": null,
            "description": "Mark's primary account"
            "name": "Mark Evans",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
         }
      ],
      "preferred": true,
      "relatedParty": null,
      "@type": "bankAccountDebit",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "accountNumber": "12341234",
         "accountNumberType": "Savings",
         "BIC": "AAAABBCCDD",
         "owner": "Mark Evans",
         "bank": "My Bank"
      }
   },
]

Example 2: Get Payment Methods by Account Number

The following example shows how to get all payment methods for a specified account number 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/accounts/account+123456/paymentMethod'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "0.0.0.1+-payinfo-cc+987654",
      "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-cc+987654",
      "name": "Joe's Tokenized Card",
      "description": null,
      "validFor": null,
      "account": [
         {
            "id": "account+123456",
            "href": null,
            "description": "Joe's primary account"
            "name": "Joe Davis",
         }
      ],
      "preferred": false,
      "relatedParty": null,
      "@type": "bankCard",
      "authorizationCode": null,
      "status": null,
      "statusDate": null,
      "details": {
         "brand": "MasterCard",
         "type": "Credit",
         "cardNumber": "5500000000000004",
         "expirationDate": "2025-02-28T11:59:59+05:30",
         "cvv": null,
         "lastFourDigits": null,
         "nameOnCard": Joe Davis,
         "bank": null
      }
   },
]
Back to Top