API Documentation
  1. Payin Method
API Documentation
  • Checkout Page
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payin Method
      • Get All Payin Method
        GET
      • Get Required Fields by Payin method
        GET
    • Payout Method
      • Get All Payout Method
      • Get Required Fields by Payout method
    • Payin
      • Create Payin
      • Simulate Payin
      • Retrieve Payin
      • Retrieve Payin Memo (PDF)
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout
      • Get All Payout
      • Retrieve Payout Memo (PDF)
    • Payout Beneficiary
      • Create Payout Beneficiary
      • Update Payout Beneficiary
      • Get All Payout Beneficiary
      • Get Payout Beneficiary by Id
      • Validation by Id
      • Validation by Body
    • Transaction
      • Find Transaction by Id
      • Get All Transaction
    • Wallet
      • Create Wallet
      • Get All Wallet
      • Get by Wallet Id
    • Customer
      • Create Customer
      • Update Customer
      • Get All Customer
      • Get Detail Customer by Id
      • Check Is Customer Wallet Ready
      • Enable Customer
      • Disable Customer
      • Delete Customer
    • Checkout
      • Create Payment Request
      • Create New Checkout
      • Get List Checkout Payment Method by Currency
      • Get All Checkout
      • Get Detail Checkout
      • Cancel Checkout
      • Get VA Bank Information [KRW]
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
  • Features Documentation
    • Dashboard
    • Transaction
      • Payin
      • Payout
      • Rolling Reserve
      • Refund Request
    • Finance
      • Settlement Report APM
      • Settlement Report CARD
      • History Balance APM
      • History Balance CARD
    • Account
      • Profile Account
      • Manage Users
    • Setting
      • Integration Details
  1. Payin Method

Get Required Fields by Payin method

GET
/api/v1/required-field/{payin_method_name}/{currency}
This API is used to retrieve the required parameters for a specific Payin Method.
The parameters are returned as a list of objects. The name of each field appears in the name variable of the payin_method_param array.

Request

Path Params
payin_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/required-field//' \
--header 'X-token;'

Responses

🟢200Success
application/json
Body
status
boolean 
required
message
string 
required
data
object 
required
payin_method_id
string 
required
payin_method_name
string 
required
payin_method_description
string 
required
payin_method_logo
string 
required
payin_method_instruction
array[string]
required
payin_method_category
string 
required
payin_method_class
string 
required
payin_method_group
string 
required
country
string 
required
currency
string 
required
payin_method_param
array [object {6}] 
required
min_amount
integer 
required
is_sender_validation_enabled
boolean 
required
max_amount
integer 
required
is_payin_method_available_24_7
boolean 
required
is_cancellable
boolean 
required
is_refundable
boolean 
required
is_multiple_refund_allowed
boolean 
required
is_partially_refundable
boolean 
required
is_over_refundable
boolean 
required
is_va_allowed
boolean 
required
is_payin_allowed
boolean 
required
max_expiration_time_in_seconds
string 
required
default_expiry_time_seconds
string 
required
Examples
{
  "status": true,
  "message": "OK",
  "data": {
    "payin_method_id": "pim_2b8cb796be6548e6ad7b88504b73a2a2",
    "payin_method_name": "au_bank_npp",
    "payin_method_description": "New Payments Platform (NPP)",
    "payin_method_logo": "https://payid.com.au/wp-content/uploads//2021/01/PayID_wordmark-Black-01.svg",
    "payin_method_instruction": [
      "Copy the PayID mentioned in this page.",
      "Open your mobile banking App and select NPP funds transfer.",
      "Transfer the funds to the PayId copied in step <1>."
    ],
    "payin_method_category": "BANK",
    "payin_method_class": "DOMESTIC",
    "payin_method_group": "NO_GROUP",
    "country": "AU",
    "currency": "AUD",
    "payin_method_param": [
      {
        "name": "payid_reference",
        "type": "text",
        "label": "PayID Ref",
        "regex": "^[a-z0-9_.+~-]{1,35}$",
        "mandatory": false,
        "field_description": ""
      },
      {
        "name": "payid_description",
        "type": "text",
        "label": "PayID Description",
        "regex": "^[a-zA-Z0-9 ]{8,35}$",
        "mandatory": false,
        "field_description": ""
      }
    ],
    "min_amount": 1,
    "is_sender_validation_enabled": false,
    "max_amount": 10000000,
    "is_payin_method_available_24_7": true,
    "is_cancellable": true,
    "is_refundable": true,
    "is_multiple_refund_allowed": false,
    "is_partially_refundable": true,
    "is_over_refundable": false,
    "is_va_allowed": true,
    "is_payin_allowed": true,
    "max_expiration_time_in_seconds": "34560000",
    "default_expiry_time_seconds": "172800"
  }
}
🟠400Bad Request
Modified at 2025-04-24 04:13:02
Previous
Get All Payin Method
Next
Get All Payout Method