Get Pending Merchant Credits

post

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

Use the Get Pending Merchant Credits endpoint to retrieve all merchant credits that are in the "pending" or "waiting to be processed" status. The programId parameter is required. Pass the accountNo parameter to get pending credits for the specified account.

See Record-Set Pagination for instructions on using the paging parameters.

Status codes

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

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"

accountNo

string | null

^.+$

The PRN, PAN or CAD of the account.
Pattern: PAN, PRN, or CAD
Example: "074103447228"

programId

int32

required

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

recordCnt

int32 | null

1 to 99999

The maximum number of records per page to be returned.
Pattern: Positive integer 1-99999
Example: 100

page

int32 | null

Defaults to 1

The number of the page to retrieve.
Pattern: Integer value of 1 or greater
Example: 3

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

Status codes

default