APIPay Ops endpointsBank changes

Create bank account change

View as MarkdownOpen in Claude
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.

Path parameters

paypointIdlongRequired
The paypoint's numeric identifier.

Request

This endpoint expects an object.
nicknamestringRequired<=250 characters
A label for the account.
bankNamestringRequired<=100 characters
The name of the bank.
routingNumberstringRequired

The 9-digit bank routing number.

accountNumberstringRequired

The bank account number (4 to 17 digits).

accountTypestringRequired

The account type. Must be checking or savings.

bankAccountHolderTypestringRequired

The account holder type. Must be personal or business.

bankAccountFunctionenumRequired

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

servicesobjectRequired
The Pay In and Pay Out services the bank account applies to. Include at least one entry across the two lists.
defaultbooleanRequired
Whether this is the default account for the selected services.
scheduleFordatetimeOptional

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
uuidstringformat: "uuid"
The case's unique identifier.
stateenum

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

caseTypeenum
Bank account changes are currently the only supported case type.
parametersobject

The bank-account-change details stored on a case. The raw account and routing numbers are write-only and never appear here — only a vault token (bankToken) and non-sensitive details.

orgIdlong
The organization that owns the case.
paypointIdlong
The paypoint the case applies to.
scheduleFordatetime or null
When the change is scheduled to run. Null when not scheduled.
createdAtdatetime
When the case was created.
updatedAtdatetime
When the case was last updated.
createdBylong

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

assigneeIdlong or null
The numeric id of the assigned reviewer. Null when unassigned.
lastReviewedByIdlong or null
The numeric id of the last reviewer. Null when not yet reviewed.
stateHistorylist of objects
The ordered history of state transitions.
attachmentslist of objects
Files attached to the case.
roomIdlong or null
The id of the message room for the case. Null until provisioned.
metadataobject or null
Case metadata, including the verification outcome. Null until verification completes.
orgobject or null
The resolved organization. Null when not enriched.
paypointobject or null
The resolved paypoint. Null when not enriched.
createdByUserobject or null

The resolved creator. Null when created by a server-side integration or not enriched.

assigneeobject or null
The resolved assigned reviewer. Null when unassigned.
lastReviewedByobject or null
The resolved last reviewer. Null when not yet reviewed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error