Deposit funds

View as MarkdownOpen in Claude
Deposits funds into a paypoint's available payout balance. Deposited funds enter a pending state and aren't available for instant payouts until confirmed through FBO reconciliation.

Authentication

requestTokenstring
API Key authentication via header

Request

This endpoint expects an object.
amountdoubleRequired
The amount to deposit, in dollars. Must be greater than zero.
entrypointstringRequired<=50 characters
The entry point identifier for the paypoint receiving the deposit.
accountIdstringRequired
The remittance account ID to withdraw funds from.
paypointIdlongOptional
The paypoint ID. Optional if the entry point uniquely identifies the paypoint.
sameDayAchbooleanOptional

When true and the request is submitted before 2 PM ET, the deposit processes as same-day ACH. If the request is submitted after 2 PM ET, it processes as standard ACH regardless of this flag.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDatamap from strings to any or null
The object containing the response data.
pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error