GAgalileo-ft
Transactions

Modify Pending Deposit Status

Use the Modify Pending Deposit Status endpoint to either post or return pending direct ACH deposits that are returned by <a href="ref:post_getpendingdeposits" target="_blank">Get Pending Deposits</a>. This endpoint is intended for a custom fraud monitoring and resolution strategy. Consult with SoFi Tech Solutions to configure your program appropriately.

For more information on this endpoint see <a href="doc:ach-endpoints#modifying-a-pending-ach-deposit-status" target="_blank">Modifying a pending ACH deposit status</a> in the ACH Endpoints guide.

post/modifyPendingDepositStatus

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/modifyPendingDepositStatus
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring nullable

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

externalAccountIdstring nullable

Identifier supplied by the provider, which is not related to the system. This ID is stored in the system in association with this account and can be provided in the <glossary:RDF>s. Pattern: Max 30 alphanumeric characters. Lowercase only. Example: "553b45sbs"

depositTransactionIdinteger required

The ACH transaction identifier (ach_trans_id), as returned by the <a href="ref:post_getpendingdeposits" target="_blank">Get Pending Deposits</a> endpoint. Pattern: Integer Example: 6844743

actionType'P' | 'R' required

Action to take on the pending deposit:

  • P — Post the deposit
  • R — Return the deposit to the sender. When returning the deposit, retCode is required

Pattern: String Example: "P"

categoryCodestring required

Category to assign to the deposit. See <a href="ref:api-reference-deposit-category-codes" target="_blank">Deposit Category Codes</a> for valid values. Pattern: String Example: "TAX"

categoryType'A' | 'W' | 'D' required

Indicates the decision for future ACH deposits that match the program settings for the current deposit. Values are:

  • A — Approve matching transactions.
  • D — Decline matching transactions.
  • W — Watch matching transactions and send for manual review.

Pattern: String Example: "D"

retCode'R02' | 'R03' | 'R04' | 'R06' | 'R08' | 'R17' | 'R23' nullable

Reason for returning the deposit. This parameter is required when actionType: R. See the <a href="ref:api-reference-modify-pending-deposit-status-return-codes" target="_blank">Return Codes</a> table for valid values. Pattern: String Example: "R02"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "externalAccountId": "553b45sbs",
  "depositTransactionId": 6844743,
  "actionType": "P",
  "categoryCode": "TAX",
  "categoryType": "D",
  "retCode": "R02"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.