Transactions

Update Payment

Use the Update Payment endpoint to update the number of hold days for a pending payment that was created with the <a href="ref:post_createpayment" target="_blank">Create Payment</a> endpoint. You should not use this endpoint to update payments created with the Create Account Transfer or Create ACH Transaction endpoint.

Consult the <a href="doc:creating-a-payment" target="_blank">Creating a Payment</a> guide for instructions on using this endpoint.

post/updatePayment

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/updatePayment
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"

accountNostring required

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

pmtIdinteger required

The payment ID (payment_trans_id) as returned by the <a href="ref:post_createpayment" target="_blank">Create Payment</a> endpoint or pmt_id as returned by the <a href="ref:post_getpaymenthistory" target="_blank">Get Payment History</a> endpoint. Pattern: Positive integer Example: 4234888

holdDaysinteger required

Number of days to hold a payment before processing. If set to 0, the payment will be posted the next time the internal payment process runs. Pattern: Integer value of 0 or greater Example: 0

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "pmtId": 4234888
}

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

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.

Changes

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