Jump to

• Request
• Response
• Examples

Get All Creditors

get

/bcws/webresources/v1.0/paymentmethods/sepa/creditors

Gets either the creditors for a specified bank or all creditors in the system.

Request

Query Parameters

• bic: string
  The bank identifier code, such as IANILKU1MAR. If the value is null, it returns all creditors.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The creditors were returned successfully.

Body ()

Root Schema : creditorInfo

Type: object

Show Source

• creditorsDetails: array creditorsDetails
  Details about a creditor.
• extension: object extension
  The extended attributes.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "creditorsDetails":{
            "type":"array",
            "description":"Details about a creditor.",
            "items":{
                "$ref":"#/components/schemas/CreditorsDetails"
            }
        }
    },
    "xml":{
        "name":"creditorInfo"
    }
}

Nested Schema : creditorsDetails

Type: array

Details about a creditor.

Show Source

• Array of: object CreditorsDetails
  Details about a creditor.

{
    "type":"array",
    "description":"Details about a creditor.",
    "items":{
        "$ref":"#/components/schemas/CreditorsDetails"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : CreditorsDetails

Type: object

Details about a creditor.

Show Source

• address(required): string
  The creditor's address.
• country(required): string
  The creditor's country.
• creditorID(required): string
  The ID for the creditor.
• name(required): string
  The creditor's name.

{
    "required":[
        "address",
        "country",
        "creditorID",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The creditor's name."
        },
        "country":{
            "type":"string",
            "description":"The creditor's country."
        },
        "address":{
            "type":"string",
            "description":"The creditor's address."
        },
        "creditorID":{
            "type":"string",
            "description":"The ID for the creditor."
        }
    },
    "description":"Details about a creditor."
}

201 Response

The creditors were returned successfully.

Body ()

Root Schema : creditorInfo

Type: object

Show Source

• creditorsDetails: array creditorsDetails
  Details about a creditor.
• extension: object extension
  The extended attributes.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "creditorsDetails":{
            "type":"array",
            "description":"Details about a creditor.",
            "items":{
                "$ref":"#/components/schemas/CreditorsDetails"
            }
        }
    },
    "xml":{
        "name":"creditorInfo"
    }
}

Nested Schema : creditorsDetails

Type: array

Details about a creditor.

Show Source

• Array of: object CreditorsDetails
  Details about a creditor.

{
    "type":"array",
    "description":"Details about a creditor.",
    "items":{
        "$ref":"#/components/schemas/CreditorsDetails"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : CreditorsDetails

Type: object

Details about a creditor.

Show Source

• address(required): string
  The creditor's address.
• country(required): string
  The creditor's country.
• creditorID(required): string
  The ID for the creditor.
• name(required): string
  The creditor's name.

{
    "required":[
        "address",
        "country",
        "creditorID",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The creditor's name."
        },
        "country":{
            "type":"string",
            "description":"The creditor's country."
        },
        "address":{
            "type":"string",
            "description":"The creditor's address."
        },
        "creditorID":{
            "type":"string",
            "description":"The ID for the creditor."
        }
    },
    "description":"Details about a creditor."
}

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get a list of SEPA creditors 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/sepa/creditors'

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,
    "creditorsDetails": [
        {
            "name": "Kreditgeber",
            "country": "DE",
            "address": "Riesstraße 2580992",
            "creditorID": "RB24DEUTSCHLAND"
        },
        {
            "name": "Creanciere",
            "country": "FR",
            "address": "15 boulevard Charles de Gaulle",
            "creditorID": "RB23FRANCE"
        },
        {
            "name": "Acreedora",
            "country": "ES",
            "address": "211 Placa de les Glories,",
            "creditorID": "RB25ESPANA"
        }   
    ]
}

Back to Top