ZINC API
HomeSign InSupport
HomeSign InSupport
  1. Beneficiary
  • API Reference
  • Authentication
    • Get Access token
      GET
  • Core Resources
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Get Account Balance
      • Submit Account For Activation
      • Get Account Transactions
      • Get Account Supported Currencies
      • Get Account Beneficiaries
    • Beneficiary
      • Add Beneficiary
        POST
      • Get Beneficiaries
        GET
      • Delete Beneficiary
        DELETE
    • Currency Accounts
      • Create Currency Account
      • Get Currency Account Details
    • Payouts
      • Create Payout
      • Get Payouts For Account
    • Cards
      • Simulation
        • Simulate Card Transaction
      • Create Card
      • Get Card Details
      • Update Transaction Limits
      • Update Cards Status
      • Get Card Transactions
    • Conversions
      • Create Conversion
      • Get Quote
    • Services
      • Upload File
  1. Beneficiary

Add Beneficiary

POST
/api/v1/beneficiary

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
account-id
string 
optional
x-api-version
string 
optional
User-Agent
string 
optional

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 POST 'https://api-sandbox.z.inc/api/v1/beneficiary' \
--header 'account-id;' \
--header 'x-api-version;' \
--header 'User-Agent;'

Responses

🟢200Success
application/json
Body
object {0}
Example
{
    "beneficiary": {
        "additional_info": {
            "personal_email": "paul.walker@gmail.com"
        },
        "address": {
            "city": "Singapore",
            "country_code": "SG",
            "postcode": "541298",
            "street_address": "BLK 241A COMPASSVALE STREET #02-143"
        },
        "bank_details": {
            "account_currency": "SGD",
            "account_name": "John Walker",
            "account_number": "1707625311",
            "bank_country_code": "SG",
            "bank_name": "DBS BANK LTD",
            "swift_code": "DBSSSGSG"
        },
        "date_of_birth": "2000-01-01",
        "entity_type": "PERSONAL"
    },
    "beneficiary_id": "4f9cb41b-29ef-4e91-99d6-bfc7c9f3c6d6",
    "nickname": "Complete Concrete Pty Ltd",
    "payer_entity_type": "COMPANY",
    "payment_methods": [
        "SWIFT"
    ]
}
Modified at 2024-07-28 14:50:05
Previous
Get Account Beneficiaries
Next
Get Beneficiaries