REST Services Manager API for Billing and Revenue Management

Get a Payment Method by ID

get

/paymentMethod/{paymentMethodId}

Gets the specified payment method by payment method ID or external ID.

Request

Path Parameters

paymentMethodId(required): string

The ID or external ID of the payment method to get.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The payment method was returned successfully.

Root Schema : PaymentMethodType

Type: object

A payment method.

Show Source

@type(required): string

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

The payment method's type: tokenizedCard, bankAccountDebit, bankCard, or invoice. 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":{
            "type":"object",
            "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&colon; <b>tokenizedCard</b>, <b>bankAccountDebit</b>, <b>bankCard</b>, or <b>invoice</b>. The value of this property determines the content of the <b>details</b> 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 <b>@type</b> 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&colon; 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&colon; <b>account</b>, <b>customer</b>, or <b>user</b>."
        },
        "name":{
            "type":"string",
            "description":"The related party's name."
        },
        "role":{
            "type":"string",
            "description":"The related party's role."
        }
    },
    "description":"A related party."
}

400 Response

The request isn't valid.

401 Response

The client doesn't have the correct privileges.

403 Response

The request wasn't authorized.

404 Response

The requested resource couldn't be found.

405 Response

This method is not allowed.

500 Response

The system encountered an internal error.

Examples

Example 1: Get a Payment Method by POID

The following example shows how to get the payment method with the specified POID 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/0.0.0.1+-payinfo-dd+240947'

Example of the Response Body

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

{
   "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"
   }
}

Example 2: Get a Payment Method by External ID

The following example shows how to get the payment method with the specified external 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/paymentMethod/Test123XYZ'

Example of the Response Body

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

{
   "id": "Test123XYZ",
   "href": "http://host:port/brm/paymentMethods/version/paymentMethod/Test123XYZ",
   "name": "John Clark's Direct Debit Account",
   "description": null,
   "validFor": null,
   "account": [
      {
         "id": "0.0.0.1+-account+244543",
         "href": null,
         "description": "John's primary account",
         "name": "John Clark",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": null,
         "@referredType": null
        }
   ],
   "preferred": true,
   "relatedParty": null,
   "@type": "TokenizedCardType",
   "authorizationCode": null,
   "status": null,
   "statusDate": null,
   "details": {
      "brand": "Visa",
      "type": "Debit",
      "lastFourDigits": "5555",
      "tokenType": "1",
      "token": "token",
      "issuer": null
   }
}