REST Services Manager API for Billing and Revenue Management

Get Payment Methods for an Account

get

/brm/paymentMethods/v1/accounts/{accountId}/paymentMethods

Gets the payment methods associated with the specified account.

Request

Path Parameters

accountId(required): string

The ID of the account to get payment methods for.

Query Parameters

bankAccount.BIC: string
The Business Identifier Code of a bank, to get bankAccountDebit payment methods.

Examples
bankAccount.accountNumber: string

The bank account number, to get a bankAccountDebit payment method.
bankAccount.bank: string
The name of a bank, to get bankAccountDebit payment methods.

Examples
bankCard.cardNumber: string

The card number, to get a bankCard payment method.
bankCard.nameOnCard: string
The name on the card, to get bankCard payment methods. You can use bankCard.nameOnCard.like= to get partial matches.

Examples
bankCard.type: string

The type of bank card, to get bankCard payment methods. The only valid value for BRM is CREDIT.
fields: string
The list of comma-separated fields to return in the response.

Examples
invoice.name: string
The name on the invoice, to get invoice payment methods. You can use invoice.name.like= to get partial matches.

Examples
limit: integer
The maximum number of results to return.

Examples
name: string
The name, to get a payment method.

Examples
offset: integer
The number of results to offset the response by.

Examples
type: string

The type of payment methods to get.

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

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The payment methods for the account were returned successfully.

Headers

X-Total-Count:

Total results

Root Schema : schema

Type: array

Show Source

Array of: object PaymentMethodType

A payment method.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentMethodType"
    }
}

Nested Schema : PaymentMethodType

Type: object

A payment method.

Show Source

@type(required): string

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

The payment method's type. The value of this property determines the content of the details property.
account: array account

An account that owns or can use the payment method.
authorizationCode: string

An authorization code provided by a financial institution. Typically for recurring payments using the payment method.
description: string

The payment method's description.
details(required): object details

The payment method's details, which differ based on the '@type' property.
href(required): string

The payment method's href.
id(required): string

The payment method's ID.
name: string

The payment method's name.
preferred: boolean

Whether this is the preferred payment method for the account, bill unit, or billing cycle specification (true) or not (false).
relatedParty: array relatedParty

The related party that owns the payment method.
status: string

The payment method's status.
statusDate: string (date-time)

The date the payment method's status was recorded.
validFor: TimePeriodType

A period of time.

{
    "required":[
        "@type",
        "details",
        "href",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The payment method's ID."
        },
        "href":{
            "type":"string",
            "description":"The payment method's href."
        },
        "name":{
            "type":"string",
            "description":"The payment method's name."
        },
        "description":{
            "type":"string",
            "description":"The payment method's description."
        },
        "validFor":{
            "description":"The period of time for which the payment method is valid.",
            "$ref":"#/components/schemas/TimePeriodType"
        },
        "account":{
            "type":"array",
            "description":"An account that owns or can use the payment method.",
            "items":{
                "$ref":"#/components/schemas/AccountRefType"
            }
        },
        "preferred":{
            "type":"boolean",
            "description":"Whether this is the preferred payment method for the account, bill unit, or billing cycle specification (<b>true</b>) or not (<b>false</b>)."
        },
        "relatedParty":{
            "type":"array",
            "description":"The related party that owns the payment method.",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefType"
            }
        },
        "@type":{
            "type":"string",
            "description":"The payment method's type. The value of this property determines the content of the details property.",
            "enum":[
                "tokenizedCard",
                "bankAccountDebit",
                "bankCard",
                "invoice"
            ]
        },
        "authorizationCode":{
            "type":"string",
            "description":"An authorization code provided by a financial institution. Typically for recurring payments using the payment method."
        },
        "status":{
            "type":"string",
            "description":"The payment method's status."
        },
        "statusDate":{
            "type":"string",
            "description":"The date the payment method's status was recorded.",
            "format":"date-time"
        },
        "details":{
            "type":"object",
            "description":"The payment method's details, which differ based on the '@type' property."
        }
    },
    "description":"A payment method."
}

Nested Schema : account

Type: array

An account that owns or can use the payment method.

Show Source

Array of: object AccountRefType

An account reference.

{
    "type":"array",
    "description":"An account that owns or can use the payment method.",
    "items":{
        "$ref":"#/components/schemas/AccountRefType"
    }
}

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

Array of: object RelatedPartyRefType

A related party.

{
    "type":"array",
    "description":"The related party that owns the payment method.",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefType"
    }
}

Nested Schema : TimePeriodType

Type: object

A period of time.

Show Source

endDateTime: string (date-time)

The end of the time period.
startDateTime(required): string (date-time)

The start of the time period.

{
    "required":[
        "startDateTime"
    ],
    "properties":{
        "startDateTime":{
            "type":"string",
            "description":"The start of the time period.",
            "format":"date-time"
        },
        "endDateTime":{
            "type":"string",
            "description":"The end of the time period.",
            "format":"date-time"
        }
    },
    "description":"A period of time."
}

Nested Schema : AccountRefType

Type: object

An account reference.

Show Source

@referredType: string

The referred account's type. For example, customer account or financial account.
description: string

The referred account's description.
href(required): string

The referred account's href.
id(required): string

The referred account's ID.
name: string

The referred account's name.

{
    "required":[
        "href",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The referred account's ID."
        },
        "href":{
            "type":"string",
            "description":"The referred account's href."
        },
        "name":{
            "type":"string",
            "description":"The referred account's name."
        },
        "description":{
            "type":"string",
            "description":"The referred account's description."
        },
        "@referredType":{
            "type":"string",
            "description":"The referred account's type. For example, customer account or financial account."
        }
    },
    "description":"An account reference."
}

Nested Schema : RelatedPartyRefType

Type: object

A related party.

Show Source

@referredType: string

The type of related party. For example, account, customer, or user.
href(required): string

The related party's href.
id(required): string

The related party's ID.
name: string

The related party's name.
role: string

The related party's role.

{
    "required":[
        "href",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The related party's ID."
        },
        "href":{
            "type":"string",
            "description":"The related party's href."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of related party. For example, account, customer, or user."
        },
        "name":{
            "type":"string",
            "description":"The related party's name."
        },
        "role":{
            "type":"string",
            "description":"The related party's role."
        }
    },
    "description":"A related party."
}

400 Response

Invalid Token

401 Response

Unauthorized

403 Response

Forbidden

405 Response

Method not Allowed

500 Response

Internal Server Error