GAgalileo-ft
Transactions

Expire Hold

Use the Expire Hold endpoint to expire a funds hold that was created with the <a href="ref:post_createhold" target="_blank">Create Hold</a> endpoint. This endpoint does not expire any other kind of hold.

post/expireHold

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/expireHold
  • 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"

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>. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

holdIdinteger nullable

Hold ID (hold_id) as returned by the <a href="ref:post_createhold" target="_blank">Create Hold</a> or <a href="ref:post_getholdhistory" target="_blank">Get Hold History</a> endpoint. Pattern: Positive integer Example: 453434

expirationDateTimestring date-time nullable

Date and time to expire the hold. Must be a date-time in the future. Leave this parameter empty to expire the hold immediately. Pattern: YYYY-MM-DD hh:mm:ss Example: "2017-01-01 13:00:00"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "holdId": 453434,
  "expirationDateTime": "2017-01-01 13:00:00"
}

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.