GAgalileo-ft
Transactions

Update Pending Merchant Credit

Changed on

Use the Update Pending Merchant Credit endpoint to post or post and hold a merchant credit if you are handling your own disputes. The threshold for manual review of merchant credits is set during product configuration using the ZREVW product parameter.

To use this endpoint, first, use the <a href="ref:post_getpendingmerchantcredit" target="_blank">Get Pending Merchant Credit</a> endpoint to retrieve the settle_id value, then pass it in the settleId parameter. Use type to specify whether to post or post and hold.

When the system receives the call to this endpoint, the credit is queued for processing.

post/updatePendingMerchantCredit

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

programIdinteger required

A unique program identifier from SoFi Tech Solutions. Pattern: Positive integer Example: 1032

settleIdstring required

The settle_id as returned by <a href="ref:post_getpendingmerchantcredits" target="_blank">Get Pending Merchant Credits</a>. Pattern: /^[a-z A-Z]{1}-[0-9]{1,20}$/ Example: "v-43843747"

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"

type'1' | '2' required

Type of update to perform on the merchant credit:

  • 1 — Post
  • 2 — Post and hold

Pattern: 1 or 2 Example: "2"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "programId": 1032,
  "settleId": "v-43843747",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "2"
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

response_dataobject required

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

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

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

system_timestampstring date-time nullable required

A system generated timestamp

Changes

  • 1ede7567a879Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 60

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status