Historical contract: Get Paymethods
Historical API contract. This page describes an earlier API contract. Methods, paths, and responses may differ from the current API.
Historical meaning
Get Paymethods
This API endpoint is used to obtain all payment options.
Current API
For new integrations, use the linked current API reference or guide.
View the current API referenceParameters
[
{
"name": "language",
"in": "path",
"schema": {
"type": "string",
"default": "en"
},
"required": true
},
{
"name": "project",
"in": "path",
"schema": {
"type": "string",
"default": "<redacted-personal>"
},
"required": true
},
{
"name": "params",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
}
]
Request body
null
Responses
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": [\n {\n \"id\": 1,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"cash\",\n \"enabled\": true\n },\n {\n \"id\": 2,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"card_delivery\",\n \"enabled\": true\n },\n {\n \"id\": 3,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paypal\",\n \"enabled\": false\n },\n {\n \"id\": 4,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paypal_adaptive\",\n \"enabled\": false\n },\n {\n \"id\": 5,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"authorize\",\n \"enabled\": true\n },\n {\n \"id\": 6,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"braintree\",\n \"enabled\": false\n },\n {\n \"id\": 7,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"mercury\",\n \"enabled\": false\n },\n {\n \"id\": 8,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"worldpay\",\n \"enabled\": false\n },\n {\n \"id\": 9,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"mercadopago\",\n \"enabled\": false\n },\n {\n \"id\": 10,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"transactium\",\n \"enabled\": false\n },\n {\n \"id\": 11,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"pexpress\",\n \"enabled\": false\n },\n {\n \"id\": 12,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"maksekeskus\",\n \"enabled\": false\n },\n {\n \"id\": 13,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"voguepay\",\n \"enabled\": false\n },\n {\n \"id\": 14,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"skrill\",\n \"enabled\": false\n },\n {\n \"id\": 15,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"payeezy\",\n \"enabled\": false\n },\n {\n \"id\": 16,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"payu\",\n \"enabled\": false\n },\n {\n \"id\": 18,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paypalpro\",\n \"enabled\": false\n },\n {\n \"id\": 19,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paygistix\",\n \"enabled\": false\n },\n {\n \"id\": 20,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"global\",\n \"enabled\": false\n },\n {\n \"id\": 21,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"btrans\",\n \"enabled\": false\n },\n {\n \"id\": 22,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"stripe\",\n \"enabled\": true\n },\n {\n \"id\": 27,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paybox\",\n \"enabled\": false\n },\n {\n \"id\": 28,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"stripe_direct\",\n \"enabled\": true\n },\n {\n \"id\": 29,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paypal_express\",\n \"enabled\": true\n },\n {\n \"id\": 30,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"paybox\",\n \"enabled\": false\n },\n {\n \"id\": 31,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"stripe_connect\",\n \"enabled\": true\n },\n {\n \"id\": 32,\n \"name\": \"<redacted-personal>\",\n \"gateway\": \"stripe_redirect\",\n \"enabled\": true\n }\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"gateway": {
"type": "string",
"example": "cash"
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"You do not have permission.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "You do not have permission."
}
}
}
}
}
}
}
}