Paycombat merchant doc
  • API Documentation
    • Master Data
    • Refund
    • Payin Method
    • Payout Beneficiary
      • Get All Payout BeneficiaryGET
      • Get By IdGET
      • CreatePOST
      • UpdatePATCH
      • Validation By IdPOST
      • Validation by bodyPOST
    • Payin
    • Payout
    • Transaction
    • Customer
    • Payout Method
  • Feature Documentation
logoPowered by Apidog
  1. API Documentation
  2. Payout Beneficiary

Create

Testing
POST/finmo/payout-beneficiary/create

Request

Header Params
X-Merchant-Identifier-Id
string 
optional
X-Type
string 
optional
Body Params application/json
type
string 
required
company
object 
optional
address_city
string 
optional
address_country
string 
optional
address_line1
string 
optional
address_line2
string 
optional
address_state
string 
optional
address_zip_code
integer 
optional
company_email
string 
optional
incorporation_country
string 
optional
name
string 
required
phone_country_code
string 
optional
phone_number
string 
optional
registration_number
string 
optional
individual
object 
optional
address_city
string 
optional
address_country
string 
optional
address_line1
string 
optional
address_line2
string 
optional
address_state
string 
optional
address_zip_code
string 
optional
country_of_residence
string 
optional
dob
string 
optional
email
string 
optional
first_name
string 
required
last_name
string 
required
identification_custom_type
string 
optional
identification_type
string 
optional
identification_value
string 
optional
nationality
string 
optional
phone_country_code
string 
optional
phone_number
string 
optional
aba
string 
optional
account_number
string 
optional
bank_code
string 
optional
bank_country
string 
optional
bank_name
string 
optional
beneficiary_name
string 
required
bic_swift
string 
optional
intermediary_bic_swift
string 
optional
branch_code
string 
optional
bsb
string 
optional
currency
string 
optional
description
string 
optional
iban
string 
optional
ifsc
string 
optional
organization_reference_id
string 
optional
pay_id
string 
optional
pay_id_type
string 
optional
sort_code
string 
optional
proxy_type
string 
optional
proxy_value
string 
optional
metadata
object 
optional
Example
{
  "type": "company",
  "company": {
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zip_code": 0,
    "company_email": "string",
    "incorporation_country": "string",
    "name": "string",
    "phone_country_code": "string",
    "phone_number": "string",
    "registration_number": "string"
  },
  "individual": {
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zip_code": "string",
    "country_of_residence": "string",
    "dob": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "identification_custom_type": "string",
    "identification_type": "string",
    "identification_value": "string",
    "nationality": "string",
    "phone_country_code": "string",
    "phone_number": "string"
  },
  "aba": "string",
  "account_number": "string",
  "bank_code": "string",
  "bank_country": "string",
  "bank_name": "string",
  "beneficiary_name": "string",
  "bic_swift": "string",
  "intermediary_bic_swift": "string",
  "branch_code": "string",
  "bsb": "string",
  "currency": "string",
  "description": "string",
  "iban": "string",
  "ifsc": "string",
  "organization_reference_id": "string",
  "pay_id": "string",
  "pay_id_type": "string",
  "sort_code": "string",
  "proxy_type": "string",
  "proxy_value": "string",
  "metadata": {}
}

Request samples

Responses

Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
object {0}
Example
{
  "status": true,
  "message": "string",
  "data": {
    "aba": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_country": "string",
    "bank_name": "string",
    "beneficiary_name": "string",
    "bic_swift": "string",
    "intermediary_bic_swift": "string",
    "branch_code": "string",
    "bsb": "string",
    "company": {
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zip_code": 0,
      "company_email": "string",
      "company_incorporation_country": "string",
      "name": "string",
      "phone_country_code": "string",
      "phone_number": "string",
      "phone_number_e164": "string",
      "registration_number": "string",
      "identification_type": "string",
      "identification_value": "string"
    },
    "created_at": "2024-12-26T10:46:24.203Z",
    "created_by": "string",
    "currency": "string",
    "description": "string",
    "iban": "string",
    "ifsc": "string",
    "is_active": true,
    "metadata": {},
    "org_id": "string",
    "organization_reference_id": "string",
    "pay_id": "string",
    "pay_id_type": "string",
    "payout_beneficiary_id": "string",
    "proxy_type": "string",
    "proxy_value": "string",
    "sort_code": "string",
    "type": "string",
    "updated_at": "2024-12-26T10:46:24.203Z"
  }
}
Last modified: 8 days ago