GET
Read many Payment Method
Retrieve all payments methods supported by LawPanel.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request parameters
(optional)
integer
Take N records. Default value is 10. Max value is 100.
(optional)
integer
Skip N records.
(optional)
string
Filter ID to apply on this endpoint. To get further details about filters click here.
(optional)
string
Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering.
Request headers
string
Subscription key which provides access to this API.
Response 200
Returns a list with all payment methods available to be used to create a Payment.
Loading...
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"payment_method_component_definitions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"class_name": {
"type": "string"
},
"pattern": {
"type": "string"
},
"mask": {},
"required": {
"type": "boolean"
},
"select_from": {},
"disabled": {
"type": "boolean"
},
"max": {},
"max_length": {
"type": "integer"
},
"min": {},
"read_only": {
"type": "boolean"
},
"step": {},
"place_holder": {},
"private": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"display_order": {
"type": "integer"
}
},
"required": [
"id",
"payment_method",
"name",
"display_name",
"class_name",
"pattern",
"mask",
"required",
"select_from",
"disabled",
"max",
"max_length",
"min",
"read_only",
"step",
"place_holder",
"private",
"internal",
"display_order"
]
}
},
"reusable": {
"type": "boolean"
}
},
"required": [
"id",
"code",
"name",
"description",
"payment_method_component_definitions",
"reusable"
]
},
"example": [
{
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services.",
"payment_method_component_definitions": [
{
"id": "7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd",
"name": "card_name",
"display_name": "Name",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"id": "c1138c80-0ee2-4f67-b2da-a7cc00ffc389",
"name": "address_line_one",
"display_name": "Address line one",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"id": "c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504",
"name": "address_line_two",
"display_name": "Address line two",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"id": "3339089b-4535-4ec1-a9b9-a7e8000a3451",
"name": "address_city",
"display_name": "City",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"id": "136678f3-6827-4ea9-9a02-a7e8000a3748",
"name": "address_state",
"display_name": "State",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
},
{
"id": "8f298718-3d17-450f-8871-a7e8000a3abc",
"name": "address_zip",
"display_name": "Zip",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 6
},
{
"id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3",
"name": "address_country",
"display_name": "Country",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 7
},
{
"id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6",
"name": "observations",
"display_name": "Observations",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 8
}
],
"reusable": true
},
{
"id": "0b655e83-d46f-432c-80d2-a7cc00ffd4d9",
"code": 2,
"name": "Bank transfer",
"description": "Wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another.",
"payment_method_component_definitions": [
{
"id": "b4a59072-0997-464f-a91a-a7e8000a41b8",
"name": "transfer_date",
"display_name": "Transfer date",
"class_name": "DateTime",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 0
},
{
"id": "daac72de-87c7-41db-91a4-a7e8000a4426",
"name": "from_bank_name",
"display_name": "From bank",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"id": "a76af918-047e-4db6-80ad-a7e8000a46a9",
"name": "from_account_number",
"display_name": "From account",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"id": "0d6c92ad-3984-4536-b008-a7e8000a4929",
"name": "account_owner",
"display_name": "Account owner",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"id": "28d552f1-b005-4442-86bd-a7e8000a4b32",
"name": "to_bank_name",
"display_name": "To bank",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"id": "b2cc3edb-4fdb-4d74-9e8e-a7e8000a4d3f",
"name": "to_account_number",
"display_name": "To account",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
}
],
"reusable": false
},
{
"id": "cc6120a1-b639-4746-8fa7-a86401891b45",
"code": 3,
"name": "Other",
"description": "Other mechanism to receive payments. Manually, etc.",
"payment_method_component_definitions": [
{
"id": "617309ec-3d1c-46bb-b233-a86401891cc9",
"name": "date",
"display_name": "Date",
"class_name": "DateTime",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 0
},
{
"id": "edda0df3-8d47-47f7-b45a-a86401891ed1",
"name": "comments",
"display_name": "Comments",
"class_name": "BigString",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
}
],
"reusable": false
}
]
}Response 204
This code is returned if there are not payment methods available to use with Payments.
Loading...