caseManagement

Create bank account change

Creates a bank-account-change case for a paypoint. The account and routing numbers are validated and tokenized before the case is saved — the raw numbers are never stored or returned. The account holder name is taken from the paypoint's legal name. On success the case is created in Submitted and asynchronous verification starts.

Available to both Platform and Enterprise Partners.

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

Request

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

Path parameters

paypointIdinteger required

The paypoint's numeric identifier.

Request body

nicknamestring required

A label for the account.

bankNamestring required

The name of the bank.

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.

defaultboolean required

Whether this is the default account for the selected services.

scheduleForstring date-time

When to run the change, as a UTC timestamp (trailing Z). Must be at least 1 hour and at most 30 days in the future. Omit to run as soon as the case is approved.

Response

The created case

uuidstring uuid required

The case's unique identifier.

state'Submitted' | 'Verifying' | 'PendingReview' | 'Assigned' | 'PendingResponse' | 'Escalated' | 'Approved' | 'AutoApproved' | 'PendingCompletion' | 'Completed' | 'Denied' | 'Error' required

The state of a case in the bank-account-change lifecycle. Completed and Denied are terminal.

caseType'BankAccountChange' required

Bank account changes are currently the only supported case type.

orgIdinteger required

The organization that owns the case.

paypointIdinteger required

The paypoint the case applies to.

scheduleForstring date-time nullable required

When the change is scheduled to run. Null when not scheduled.

createdAtstring date-time required

When the case was created.

updatedAtstring date-time required

When the case was last updated.

createdByinteger required

The numeric id of the user who created the case. 0 when created by a server-side integration.

assigneeIdinteger nullable required

The numeric id of the assigned reviewer. Null when unassigned.

lastReviewedByIdinteger nullable required

The numeric id of the last reviewer. Null when not yet reviewed.

roomIdinteger nullable required

The id of the message room for the case. Null until provisioned.

Changes

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