Ledger API
  1. Beneficiary
Ledger API
  • Agent
    • Update Notification URL
      POST
    • Get current agent principal
      GET
  • Ledger
    • Activate Ledger
      POST
    • List All Ledgers
      GET
    • Get Ledgers
      GET
    • Create Ledger
      POST
    • Get Customer Ledgers
      GET
    • Create Customer Ledger
      POST
    • Create Customer Multi-currency Ledger
      POST
    • Get Ledger by Id
      GET
    • Delete Ledger
      DELETE
    • Generate and Export Ledger Statement (PDF)
      GET
  • Transaction
    • Create Transaction
      POST
    • Get Ipn Status
      POST
    • Execute Transaction
      POST
    • Cancel Transaction
      POST
    • Search Transactions
      POST
    • Create FX Quote
      POST
    • Get Transaction by Id
      GET
    • List POP Codes (SWIFT Related)
      GET
    • Get FX quote
      GET
    • Get SWIFT Transaction Raw Data
      GET
  • Customer
    • Get Customers
    • Create Customer
    • Update Customer
    • Update Customer Current Address
    • Get Customer by id
  • Beneficiary
    • Get Customer Beneficiaries
      GET
    • Create Customer Beneficiary
      POST
    • Get Beneficiaries
      GET
    • Create Agent Beneficiary
      POST
    • Beneficiary Update
      POST
    • Create Beneficiary Ledger
      POST
    • Beneficiary Update Address
      POST
    • Add Address For Beneficiary
      POST
    • Beneficiary validate account name(Confirmation of Payee)
      POST
    • Get Customer Beneficiary Ledgers by Beneficiary Id
      GET
    • Get Beneficiary by Id
      GET
    • Delete Beneficiary
      DELETE
    • Get Beneficiary Ledgers by Beneficiary Id
      GET
  • Beneficiary V2 (SWIFT)
    • Create Agent Beneficiary
    • Validate Payment Scheme Fields
    • Create Customer Beneficiary
    • List Payment Scheme Currencies
    • List Payment Scheme Countries
  • Lookup
    • List Industries
    • Deposit Transaction Reject Codes
    • List Corporation Types
    • Cancel Request Reject Codes
  • Developer
    • Send Status for Outgoing Payments
    • Send Incoming Payment
  • Bank Reference Data
    • Get banks by country
    • Get bank branches
  • Customer Director Management
    • Get Directors for Customer
    • Create Director for Customer
    • Update Director
    • Delete Director
  • Schemas
    • Schemas
      • UltimateParty
      • UltimateInfo
      • BankDetailExtraData
      • PasswordRecoveryCommand
      • SimulationPaymentStatusCommand
      • BankBranchReferenceData
      • CreateUpdateAgentDirectorCommand
      • AddressDTO
      • SimulationPaymentStatusPayload
      • BankReferenceData
      • BankDetailDTO
      • PartyInfo
      • LedgerDTO
      • SimulationAddress
      • AgentLedgerDTO
      • DirectorDTO
      • MonetaryAmount
      • SimulationPaymentsInCommand
      • TransactionCommand
      • SimulationPaymentsInPayload
      • FxQuoteDTO
      • TransactionDTO
      • TransactionCancelCommand
      • TransactionFilter
      • DefaultPageable
      • CreateFxQuoteCommand
      • AgentFxQuoteDTO
      • CreateLedgerCommand
      • CompanyDetails
      • ContactMigrationDetailsDTO
      • PersonDetails
      • SearchLedgerCommand
      • LedgerMultiDTO
      • UpdateIpnCommand
      • AgentDTO
      • CompanyDTO
      • ComplianceCredentialDTO
      • PhoneNumber
      • ApproveTransactionCommand
      • RejectTransactionCommand
      • CentrolinkManualTransactionCommand
      • ClearbankManualTransactionCommand
      • ManualBulkManualTransactionCommand
      • CreateAgentCustomerCommand
      • PersonDTO
      • ContactAddressDTO
      • CustomerDTO
      • UpdateAgentCustomerCommand
      • AddLedgerToBankDetailCommand
      • CreateBeneficiaryCommand
      • BeneficiaryDTO
      • UpdateAgentCustomerAddressCommand
      • UpdateBeneficiaryCommand
      • CreateBeneficiaryLedgerCommand
      • UpdateBeneficiaryAddressCommand
      • NameVerificationCommand
      • NameVerificationResponse
      • PaymentSchemeBeneficiaryCommand
      • PaymentSchemeFieldsCommand
      • GroupNode
      • PaymentSchemeFieldDTO
      • PaymentSchemeFieldsResponse
      • PaymentSchemeOptionDTO
      • PurposeOfPaymentCode
      • PurposeOfPaymentCodes
      • Principle
      • PaymentSchemeCurrencyDTO
      • PaymentSchemeCountryDTO
  1. Beneficiary

Create Customer Beneficiary

POST
/v1/agents/customers/{id}/beneficiaries

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK
*/*
OK
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox-ledger.fingates.net/api/v1/agents/customers//beneficiaries' \
--header 'Content-Type: application/json' \
--data-raw '{
    "person": {
        "extra": {
            "property1": "string",
            "property2": "string"
        },
        "email": "user@example.com",
        "phone_number": {
            "country_code": "GB",
            "dial_code": "string",
            "number": "string",
            "phone_number_text": "string",
            "phone": "string"
        },
        "name": "string",
        "date_of_birth": "string",
        "country_of_residence": "GB",
        "country_of_nationality": "GB",
        "social_security_number": "string",
        "identity_number": "string",
        "identity_number_type": "PASSPORT",
        "nationalities": [
            "GB"
        ]
    },
    "company": {
        "extra": {
            "property1": "string",
            "property2": "string"
        },
        "email": "user@example.com",
        "phone_number": {
            "country_code": "GB",
            "dial_code": "string",
            "number": "string",
            "phone_number_text": "string",
            "phone": "string"
        },
        "name": "string",
        "trading_name": "string",
        "incorporation_locality": "GB",
        "corporation_type": "PRIVATE_COMPANY_LIMITED_BY_SHARES",
        "industry": "ACCOUNTING",
        "legal_entry_number": "string",
        "foundation_date": "string",
        "director_name": "string"
    },
    "bank_detail": {
        "account_number": "string",
        "bank_code": "string",
        "bank_code_type": "BRANCH_CODE",
        "country_code": "GB",
        "name": "string",
        "bic_swift": "FNHOGB2LXXX",
        "bic_iban": "FNHOGB21XXX",
        "iban": "string",
        "address": {
            "country_code": "GB",
            "city": "string",
            "street": "string",
            "postal_code": "string",
            "address_line1": "string",
            "address_line2": "string",
            "region": "string",
            "trading_address": true,
            "current_address": true
        },
        "swift_enabled": true,
        "sepa_enabled": true,
        "chaps_enabled": true,
        "currency": "EUR",
        "extra": {
            "branch_code": "string"
        }
    },
    "addresses": [
        {
            "country_code": "GB",
            "city": "string",
            "street": "string",
            "postal_code": "string",
            "address_line1": "string",
            "address_line2": "string",
            "region": "string",
            "trading_address": true,
            "current_address": true
        }
    ]
}'
Response Response Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "holder_id": "00651377-7deb-4de1-8500-fc7d175b624b",
    "entity_status": "ACTIVE",
    "person": {
        "extra": {
            "property1": "string",
            "property2": "string"
        },
        "email": "user@example.com",
        "phone_number": {
            "country_code": "GB",
            "dial_code": "string",
            "number": "string",
            "phone_number_text": "string",
            "phone": "string"
        },
        "name": "string",
        "date_of_birth": "string",
        "country_of_residence": "GB",
        "country_of_nationality": "GB",
        "social_security_number": "string",
        "identity_number": "string",
        "identity_number_type": "PASSPORT",
        "nationalities": [
            "GB"
        ]
    },
    "company": {
        "extra": {
            "property1": "string",
            "property2": "string"
        },
        "email": "user@example.com",
        "phone_number": {
            "country_code": "GB",
            "dial_code": "string",
            "number": "string",
            "phone_number_text": "string",
            "phone": "string"
        },
        "name": "string",
        "trading_name": "string",
        "incorporation_locality": "GB",
        "corporation_type": "PRIVATE_COMPANY_LIMITED_BY_SHARES",
        "industry": "ACCOUNTING",
        "legal_entry_number": "string",
        "foundation_date": "string",
        "director_name": "string"
    },
    "addresses": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "address": {
                "country_code": "GB",
                "city": "string",
                "street": "string",
                "postal_code": "string",
                "address_line1": "string",
                "address_line2": "string",
                "region": "string",
                "trading_address": true,
                "current_address": true
            },
            "created_at": 1668717762,
            "active": true
        }
    ],
    "ledgers": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "holder_id": "00651377-7deb-4de1-8500-fc7d175b624b",
            "balance": {
                "amount": 99.96,
                "currency": "USD"
            },
            "status": "ACTIVE",
            "enabled": true,
            "bank_detail": {
                "account_number": "string",
                "bank_code": "string",
                "bank_code_type": "BRANCH_CODE",
                "country_code": "GB",
                "name": "string",
                "bic_swift": "FNHOGB2LXXX",
                "bic_iban": "FNHOGB21XXX",
                "iban": "string",
                "address": {
                    "country_code": "GB",
                    "city": "string",
                    "street": "string",
                    "postal_code": "string",
                    "address_line1": "string",
                    "address_line2": "string",
                    "region": "string",
                    "trading_address": true,
                    "current_address": true
                },
                "swift_enabled": true,
                "sepa_enabled": true,
                "chaps_enabled": true,
                "currency": "EUR",
                "extra": {
                    "branch_code": "string"
                }
            },
            "compliance_account_id": "0efdf7c4-f251-41ae-90f1-e731544464f0",
            "type": "STANDARD"
        }
    ]
}
Modified at 2025-07-09 07:59:10
Previous
Get Customer Beneficiaries
Next
Get Beneficiaries
Built with