Update Pending Merchant Credit

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/updatePendingMerchantCredit

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 Get Pending Merchant Credit 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.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
556-01	Merchant credit not found

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

settleId

string

required

^[a-zA-Z]{1}\-[0-9]{1,20}$

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

type

string

enum

required

Type of update to perform on the merchant credit:

1 — Post
2 — Post and hold

Pattern: 1 or 2
Example: "2"

Allowed:

programId

int32

required

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

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default