Expire Hold

post

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

Use the Expire Hold endpoint to expire a funds hold that was created with the Create Hold endpoint. This endpoint does not expire any other kind of hold.

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
540-01	Provided hold ID does not map to an active hold in our system
540-02	Provided expiration date needs to be in the correct format (YYYY-MM-DD HH:MM:SS) and needs to be in the future. Omit this field if you want to expire the hold immediately.
540-03	An unknown error occurred while creating the hold. Please contact client support if this error persists

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"

holdId

int32 | null

Hold ID (hold_id) as returned by the Create Hold or Get Hold History endpoint.
Pattern: Positive integer
Example: 453434

expirationDateTime

date-time | null

Date and time to expire the hold. Must be a date-time in the future. Leave this parameter empty to expire the hold immediately.
Pattern: YYYY-MM-DD hh:mm:ss
Example: "2017-01-01 13:00:00"

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

Response

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

application/json

application/xml

Status codes

default