caseManagement

Validate bank account change

Validates a bank account change for a paypoint without creating a case. Runs the same checks the create endpoint runs, and returns blocking conditions and warnings. Blocking conditions prevent creation; warnings don't.

Available to both Platform and Enterprise Partners.

post/v2/cases/bank-account/{paypointId}/validate

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/v2/cases/bank-account/{paypointId}/validate
  • Auth: HTTP bearer

Path parameters

paypointIdinteger required

The paypoint's numeric identifier.

Request body

routingNumberstring required

The 9-digit bank routing number.

accountNumberstring required

The bank account number (4 to 17 digits).

accountTypestring required

The account type. Must be checking or savings.

bankAccountHolderTypestring required

The account holder type. Must be personal or business.

bankAccountFunction'Deposits' | 'Withdrawals' | 'DepositsAndWithdrawals' | 'Remittances' | 'RemittancesAndDeposits' | 'RemittancesAndWithdrawals' | 'RemittancesDepositsAndWithdrawals' required

What the bank account is used for. None isn't accepted on a request.

Response

Validation result

isValidboolean required

Whether the request can be created. False when there are blocking conditions.

blockingConditionsstring[] required

Conditions that prevent creation. Must be resolved first.

warningsstring[] required

Informational warnings. Creation can still proceed.

validationErrorsstring[] required

Field-level validation errors.

Changes

No recorded changes to this operation across all 1 revision of this API.