- Checkout Page
- API Documentation
- Master Data
- Payin Method
- Payout Method
- Payin
- Payout
- Payout Beneficiary
- Transaction
- Wallet
- Customer
- Checkout
- Webhook
- Features Documentation
Get Required Fields by Payout method
GET
/api/v1/payout_method/required-field/{payout_method_name}/{currency}
Request
Path Params
payout_method_name
string
required
currency
string
required
Header Params
X-token
string
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.paycombat.com/api/v1/payout_method/required-field//' \
--header 'X-token;'
Responses
🟢200Success
application/json
Body
status
boolean
required
message
string
required
data
object
required
payout_method_id
string
required
payout_method_name
string
required
payout_method_description
string
required
payout_method_logo
string
required
currency
string
required
sender_country
string
required
sender_currency
string
required
beneficiary_country
string
required
beneficiary_currency
string
required
payout_method_category
string
required
payout_method_class
string
required
payout_method_group
string
required
payout_method_param
object
required
payout_beneficiary_param
object
required
min_amount
integer
required
max_amount
integer
required
is_returnable
boolean
required
is_contract_required
boolean
required
is_enabled_by_default
boolean
required
Example
{
"status": true,
"message": "OK",
"data": {
"payout_method_id": "pom_1a3f27eb698f4854bdfc26c81d4c1c33",
"payout_method_name": "au_bank_acct",
"payout_method_description": "Payout using BSB & Account No",
"payout_method_logo": "https://payid.com.au/wp-content/uploads//2021/01/PayID_wordmark-Black-01.svg",
"currency": "AUD",
"sender_country": "AU",
"sender_currency": "AUD",
"beneficiary_country": "AU",
"beneficiary_currency": "AUD",
"payout_method_category": "BANK",
"payout_method_class": "DOMESTIC",
"payout_method_group": "NO_GROUP",
"payout_method_param": {},
"payout_beneficiary_param": {
"company": [
{
"name": "name",
"type": "text",
"regex": "^[ -~]{1,100}$",
"mandatory": true,
"field_description": "",
"regex_description": "accepts alphanumeric and special characters [length: 1 to 100]"
}
],
"base_param": [
{
"name": "bsb",
"type": "text",
"regex": "^[0-9]{3}-?[0-9]{3}$",
"mandatory": true,
"field_description": "",
"regex_description": "accepts digits and special character(-) [eg: XXX-XXX or XXXXXX] [length: 6 to 7]"
},
{
"name": "account_number",
"type": "text",
"regex": "^[0-9]{6,12}$",
"mandatory": true,
"field_description": "",
"regex_description": "accepts digits [length: 6 to 12]"
}
],
"individual": [
{
"name": "first_name",
"type": "text",
"regex": "^[ -~]{1,50}$",
"mandatory": true,
"field_description": "",
"regex_description": "accepts alphanumeric and special characters [length: 1 to 50]"
},
{
"name": "last_name",
"type": "text",
"regex": "^[ -~]{1,50}$",
"mandatory": false,
"field_description": "",
"regex_description": "accepts alphanumeric and special characters [length: 1 to 50]"
}
]
},
"min_amount": 1,
"max_amount": 1000000000,
"is_returnable": true,
"is_contract_required": false,
"is_enabled_by_default": true
}
}
🟠400Bad Request
Modified at 2025-04-24 04:49:59