https://{your-domain}.fincode.software/api/v6/services/paymentmanagement/supported-payment-methods
{
"status": "<string>",
"data": {
"paymentMethodsMetadata": [
{
"provider": "<string>",
"type": "<string>",
"hosted": true,
"paymentDetails": {},
"principalAmount": 123,
"total-amount": 123
}
],
"paymentTermsNConditions": "<string>"
}
}API Endpoints
Payment Methods
Retrieves available payment methods for a specific transaction context.
POST
/
paymentmanagement
/
supported-payment-methods
https://{your-domain}.fincode.software/api/v6/services/paymentmanagement/supported-payment-methods
{
"status": "<string>",
"data": {
"paymentMethodsMetadata": [
{
"provider": "<string>",
"type": "<string>",
"hosted": true,
"paymentDetails": {},
"principalAmount": 123,
"total-amount": 123
}
],
"paymentTermsNConditions": "<string>"
}
}This endpoint returns the supported payment methods (e.g., Card, Open Banking) for a given transaction context. It requires details about the sender’s country, transaction amount, and currency to determine the available options and applicable fees.
https://{your-domain}.fincode.software/api/v6/services/paymentmanagement/supported-payment-methods
Request Headers
string
required
The JWT Access Token of the authenticated user.
string
default:"fincode"
required
Platform identifier. Use
fincode.string
default:"200"
required
Unique request identifier.
string
default:"application/json"
required
Must be
application/json.Request Body
string
required
The 3-letter ISO code of the sender’s country (e.g.,
GBR). Available from the login response.string
default:"PAYMENT_METHOD"
required
The type of transaction context. Always
PAYMENT_METHOD.string
required
The source currency code (e.g.,
GBP).string
required
The Transaction Reference Number (PCN) obtained from the create transaction step.
string
required
The transaction amount.
string
default:"TRANSACTION"
required
The type of payable item. Always
TRANSACTION.string
required
The application identifier (e.g.,
com.app.your_app_identifier).Response
string
Request status (e.g.,
SUCCESS).object
Contains the payment method metadata.
Show data object
Show data object
array
List of available payment methods.
Show paymentMethodsMetadata item
Show paymentMethodsMetadata item
string
The payment provider (e.g.,
VOLUME, SECURE_TRADING).string
The payment type (e.g.,
ONLINE_BANK_PAYMENT, ONLINE_CARD_PAYMENT).boolean
Indicates if the payment flow is hosted.
object
Provider-specific details for the payment flow (e.g.,
hosted_gateway_url, paymentIntentId).number
The principal amount to be paid.
number
The total amount including fees.
string
URL to the payment terms and conditions.
Code Examples
curl -X POST 'https://{your-domain}.fincode.software/api/v6/services/paymentmanagement/supported-payment-methods' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'platform: fincode' \
--header 'uuid: 200' \
--header 'Content-Type: application/json' \
--data '{
"countryIsoCode3": "GBR",
"transactionType": "PAYMENT_METHOD",
"currency": "GBP",
"pcn": "TR656516344451",
"amount": "2.000",
"payAbleType": "TRANSACTION",
"appId": "com.app.your_app_identifier"
}'
const axios = require('axios');
const response = await axios.post(
'https://{your-domain}.fincode.software/api/v6/services/paymentmanagement/supported-payment-methods',
{
countryIsoCode3: 'GBR',
transactionType: 'PAYMENT_METHOD',
currency: 'GBP',
pcn: 'TR656516344451',
amount: '2.000',
payAbleType: 'TRANSACTION',
appId: 'com.app.your_app_identifier'
},
{
headers: {
'X-Auth-Token': 'YOUR_JWT_ACCESS_TOKEN',
'platform': 'fincode',
'uuid': '200',
'Content-Type': 'application/json'
}
}
);