Beneficiary Management

These API endpoints allow tenants to manage payment beneficiaries in the FinTrans™ transaction processing system, enabling customers to store and manage recipients for financial transactions.

Use Cases

  • Creating new payment beneficiaries
  • Retrieving a customer’s beneficiary list
  • Updating beneficiary information
  • Managing beneficiary status and verification
  • Supporting recurring payment workflows

Integration Notes

Beneficiary management is an essential component of the payment capabilities in the FinTrans™ platform. The beneficiary system supports:

  • Individual and business beneficiaries
  • Domestic and international payment recipients
  • Multiple payment methods and account types
  • Beneficiary verification and risk assessment
  • Compliance with regulatory requirements

For Enterprise subscription tier tenants with the Multi-Currency Financial Operation capability (SCT09), additional beneficiary features are available to support cross-border payments.

Key Endpoints

Get Customer Beneficiaries

GET /v2/beneficiary/{customerId}

Retrieves all beneficiaries for a specific customer.

Update Beneficiary

PUT /v2/beneficiary/{beneficiaryId}

Updates information for a specific beneficiary.

Get Organization Beneficiaries

GET /v2/beneficiaryByOrgId/{organizationId}

Retrieves all beneficiaries for a specific organization.

Response Codes

CodeDescription
200Operation successful
400Invalid request parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient permissions
404Beneficiary or customer not found
500Internal Server Error