Jump to

• Request
• Response
• Examples

Get Payment Methods for an Account

get

/bcws/webresources/v1.0/paymentmethods/account/{id}

Returns all payment methods for the specified account.

Request

Path Parameters

• id(required): string
  The ID of the account, such as 0.0.0.1+-account+4567890, to get payment methods for.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The payment methods were returned successfully.

Body ()

Root Schema : paymentMethods

Type: object

Show Source

• extension: object extension
  The extended attributes.
• paymentMethods: object Wallet

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentMethods":{
            "$ref":"#/components/schemas/Wallet"
        }
    },
    "xml":{
        "name":"paymentMethods"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Wallet

Type: object

Show Source

• extension: object extension
  The extended attributes.
• paymentInstrument: array paymentInstrument

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentInstrument":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"object",
                        "properties":{
                            "namespaceURI":{
                                "type":"string"
                            },
                            "localPart":{
                                "type":"string"
                            },
                            "prefix":{
                                "type":"string"
                            }
                        }
                    },
                    "value":{
                        "$ref":"#/components/schemas/PaymentInstrumentType"
                    },
                    "nil":{
                        "type":"boolean"
                    },
                    "globalScope":{
                        "type":"boolean"
                    },
                    "typeSubstituted":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : paymentInstrument

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"object",
                "properties":{
                    "namespaceURI":{
                        "type":"string"
                    },
                    "localPart":{
                        "type":"string"
                    },
                    "prefix":{
                        "type":"string"
                    }
                }
            },
            "value":{
                "$ref":"#/components/schemas/PaymentInstrumentType"
            },
            "nil":{
                "type":"boolean"
            },
            "globalScope":{
                "type":"boolean"
            },
            "typeSubstituted":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• globalScope: boolean
• name: object name
• nil: boolean
• typeSubstituted: boolean
• value: object PaymentInstrumentType

{
    "type":"object",
    "properties":{
        "name":{
            "type":"object",
            "properties":{
                "namespaceURI":{
                    "type":"string"
                },
                "localPart":{
                    "type":"string"
                },
                "prefix":{
                    "type":"string"
                }
            }
        },
        "value":{
            "$ref":"#/components/schemas/PaymentInstrumentType"
        },
        "nil":{
            "type":"boolean"
        },
        "globalScope":{
            "type":"boolean"
        },
        "typeSubstituted":{
            "type":"boolean"
        }
    }
}

Nested Schema : name

Type: object

Show Source

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

Nested Schema : PaymentInstrumentType

Type: object

Show Source

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• extension: object extension
  The extended attributes.
• id: string
  The ID.
• name: string
  The payment instrument's name.
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get an account's payment methods by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/paymentmethods/account/0.0.0.1+-account+57615'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "paymentMethods": {
        "extension": null,
        "paymentInstrument": [
            {
                "name": "{http://xmlns.oracle.com/cgbu/schemas/BusinessObjs}invoice",
                "declaredType": "com.oracle.communications.brm.cc.model.InvoiceType",
                "scope": "javax.xml.bind.JAXBElement$GlobalScope",
                "value": {
                    "extension": null,
                    "id": "0.0.0.1+-payinfo-invoice+59663",
                    "name": "Invoice Payment Type",
                    "paymentType": 10001,
                    "accountRef": {
                        "id": "0.0.0.1+-account+57615",
                        "uri": null
                    },
                    "correctiveInvoiceType": 0,
                    "details": {
                        "invoiceId": "1234",
                        "address": "2300 Oracle Way",
                        "city": "Austin",
                        "country": "US",
                        "deliveryPrefer": "1",
                        "emailAddr": "[e-mail]",
                        "name": "Mary Williams",
                        "state": "TX",
                        "zip": "78741",
                        "elem": null
                    }
                },
                "nil": false,
                "globalScope": true,
                "typeSubstituted": false
            }
        ]
    }
}

Back to Top