Skip to main content

Phase 7: Payment Consent Setup

Payment consents define what transactions the organization can perform, including limits, allowed beneficiaries, and approval requirements.
Consent TypeDescription
TRANSFERStandard transfers to beneficiaries
RECURRINGRecurring/scheduled payments
BULKBulk payment processing
INTERNATIONALCross-border transfers

Endpoint: POST /api/v2.1/fintrans/{walletId}/payment-consents/types/transferHeaders:
Authorization: Bearer {jwt-token}
Content-Type: application/json
Request Body:
{
  "title": "Regular Business Payments Consent",
  "description": "Monthly supplier and vendor payments",
  "validFrom": "2026-01-15T00:00:00.000Z",
  "validTo": "2026-12-31T23:59:59.000Z",
  "maxUsageCount": 500,
  "limits": {
    "perTransaction": {
      "amount": 10000000,
      "currency": "EUR"
    },
    "perDay": {
      "amount": 20000000,
      "currency": "EUR"
    },
    "perMonth": {
      "amount": 50000000,
      "currency": "EUR"
    }
  },
  "beneficiaryRestrictions": {
    "allowedAccounts": [
      "GB82WEST12345698765432",
      "FR7612345678901234567890123",
      "DE89370400440532013000"
    ],
    "allowedTypes": ["INTERNAL", "SEPA", "SWIFT"],
    "allowNewBeneficiaries": false,
    "requireBeneficiaryName": true,
    "requireInvoiceReference": true
  },
  "frequencyLimit": {
    "maxTransactionsPerDay": 50,
    "maxTransactionsPerWeek": 200,
    "maxTransactionsPerMonth": 500
  },
  "approvalRequirements": {
    "requiresApproval": true,
    "approvalThreshold": 5000000,
    "approverRoles": ["TRANSACTION_APPROVER", "ADMIN_USER"],
    "minimumApprovers": 1
  }
}

Amount Format: All amounts are in minor units (cents). Example: 10000000 = €100,000.00
Limit TypeDescription
perTransactionMaximum amount per single transaction
perDayMaximum total amount per day
perMonthMaximum total amount per month

Beneficiary Restrictions

FieldDescription
allowedAccountsList of allowed beneficiary IBANs
allowedTypesAllowed beneficiary types (INTERNAL, SEPA, SWIFT)
allowNewBeneficiariesAllow payments to new beneficiaries
requireBeneficiaryNameRequire beneficiary name verification
requireInvoiceReferenceRequire invoice reference for payments
When allowNewBeneficiaries is false, transactions to beneficiaries not in allowedAccounts will be rejected.

Approval Requirements

FieldDescription
requiresApprovalEnable approval workflow
approvalThresholdAmount threshold for approval (in cents)
approverRolesRoles that can approve
minimumApproversMinimum number of approvers required

Approval Workflow


Frequency Limits

LimitDescription
maxTransactionsPerDayMax transactions in 24 hours
maxTransactionsPerWeekMax transactions in 7 days
maxTransactionsPerMonthMax transactions in 30 days

List Payment Consents

Endpoint: GET /api/v2.1/fintrans/{walletId}/payment-consents

Next Step

After setting up payment consents, proceed to Phase 8: Transaction Operations.

Phase 8: Transaction Operations

Execute transfers and manage transactions