Create Hold

post

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

Use the Create Hold endpoint to create a hold (reserve) on an amount of funds for a specified payment, or to create a hold on an account in general. This endpoint supports remote deposit capture (RDC).

To create a hold on a specific payment you must pass amount and pmtId. The default hold limit is 1 000 000. You can override this limit with the MXHLD program parameter.

To create a hold on an account, your program parameters (THOLD) must specify that an account hold is valid for the holdType parameter.

This endpoint does not create authorization holds on an account for card-association transactions — such holds are created automatically when an authorization request is approved.

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
539-01	Holds are not enabled for this product/program. Please contact client support for more information.
539-02	Provided XID does not map to a valid balance in our system
539-03	Provided expiration date needs to be in the correct format (YYYY-MM-DD HH:MM:SS) and needs to be in the future
539-04	Provided payment id is invalid
539-05	No payment id was provided and the provided account hold type is missing or invalid
539-06	Amount must be equal to or less than the payment minus any other holds that have already been placed
539-07	An unknown error occurred while creating the hold. Please contact client support if this error persists.
539-08	Amount must be equal to or less than the account balance. Set PRVNB to enable this status.

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

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

amount

float

required

0.01 to 999999999999.99

Currency amount as a whole or decimal amount.
Pattern: Positive integer or decimal number
Example: 100.00, 100, or 100.73

expirationDateTime

date-time

required

Date and time when the hold expires.
Pattern: YYYY-MM-DD hh:mm:ss
Example: "2017-01-01 13:00:00"

pmtId

int32 | null

1 to 9999999999

The ID of the payment to hold: payment_trans_id as returned by the Create Payment endpoint or pmt_id as returned by the Get Payment History endpoint.
Pattern: Positive integer
Example: 4234888

holdType

string | null

Transaction type for the hold. Use the values provided by Galileo for your program.
Pattern: 2 alphanumeric characters
Example: "MO"

description

string | null

Description for the hold.
Pattern: Max 80 alphanumeric characters, including punctuation
Example: "One time payroll load."

externalId

string | null

External identifier for a hold.
Pattern: Max 60 alphanumeric characters
Example: "45348bacd483348"

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