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(required): 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 TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The creditors were returned successfully.
Root Schema : creditorInfo
Type:
Show Source
object
-
creditorsDetails: array
creditorsDetails
Details about a creditor.
-
extension: object
extension
The extended attributes.
Nested Schema : creditorsDetails
Type:
array
Details about a creditor.
Show Source
-
Array of:
object CreditorsDetails
Details about a creditor.
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.
201 Response
The creditors were returned successfully.
Root Schema : creditorInfo
Type:
Show Source
object
-
creditorsDetails: array
creditorsDetails
Details about a creditor.
-
extension: object
extension
The extended attributes.
Nested Schema : creditorsDetails
Type:
array
Details about a creditor.
Show Source
-
Array of:
object CreditorsDetails
Details about a creditor.
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.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.
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"
}
]
}