GAgalileo-ft
Transactions

Get Pending Merchant Credits

Changed on

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 <a href="ref:record-set-paging" target="_blank">Record-Set Pagination</a> for instructions on using the paging parameters.

post/getPendingMerchantCredits

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/getPendingMerchantCredits
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring nullable

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

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"

pageinteger nullable

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

programIdinteger required

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

recordCntinteger nullable

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

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"

Example request

{
  "accountNo": "074103447228",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "page": 3,
  "programId": 1032,
  "recordCnt": 100,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000"
}

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

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

      the request property format was generalized from int32 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status