Skip to main content

Get Authorization Hold

GET 
/authorization-holds/:id

(In Development)

Authorization holds API allows balance blocking for transfer operations. This allows for ensuring balance is available when a transfer is ordered and avoids balance not enough failures.

Retrieve details on an authorization hold by ID.

Request​

Path Parameters

    id stringrequired

    Authorization hold id.

Responses​

OK

Schema

    id string

    Authorization hold id.

    customerId stringrequired

    Customer Id.

    accountId string

    Customer account id.

    amount int64required

    Amount to block.

    currencyCode Currency (string)required

    Possible values: >= 3 characters and <= 3 characters

    Currency alphabetic code as specified by ISO 4217

    createdOn date-time

    Represents RFC 3339, section 5.6 date-time.

    expiresOn date-time

    Represents RFC 3339, section 5.6 date-time.

    status string

    Possible values: [ACTIVE, EXPIRED, USED, RELEASED]

    Status of the authorization hold.

Loading...