Guard

Get all guards

Returns a list of all guards associated with the regulated entity.

get/api-regulated/v1/guards

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/guards
  • Auth: HTTP bearer

Query parameters

status'ERROR' | 'CANCELLED' | 'PENDING' | 'AWAITING_FEE' | 'ACTIVE' | 'COMPLETE' | 'LAPSED' | 'VOID' | 'EXTENDED'

Filter guards by status

Response

Guards retrieved

idstring

Reference for this guard. The original is bare; extensions carry an -E{nn} suffix.

originalGuardIdstring

Id of the original Guard at the start of the lifecycle. Constant through extensions.

previousGuardIdstring

Id of the Guard generation this one extended. NULL on an original.

introducingBrokerIdstring uuid

ID of the introducing broker for this guard (denormalized from company)

regulatedUserIdstring uuid

ID of the regulated user who booked this guard

salesUserIdstring uuid

ID of the sales user who sold this guard

companyIdstring uuid

ID of the company associated with this guard

customerIdstring uuid

ID of the customer who owns this guard

guardStatus'ERROR' | 'CANCELLED' | 'PENDING' | 'AWAITING_FEE' | 'ACTIVE' | 'COMPLETE' | 'LAPSED' | 'VOID' | 'EXTENDED'

Status of this guard

externalRefstring

External reference for the guard. Could be the beneficiary identifier or a foreign key in the PSP platform. Avoid using Personally Identifiable Information in this field.

invoiceExternalRefstring

External reference of the customer invoice this guard protects. Copied from the guard quote at purchase. Avoid using Personally Identifiable Information in this field.

guardPeriodFromstring

Start period date of this guard, also the purchase date

tradeDatestring

Trade date for this guard. The actual transaction datetime when the guard was created or extended.

settlementWindowFromstring

Start settlement window of this guard, typically two weeks due date of the final payment

settlementWindowTostring

End settlement window of this guard, typically the due date of the final payment

guardCurrencystring

The Guard currency is the currency in which the cost or receivable is being protected typically the corporate base currency

foreignCurrencystring

Foreign currency of this guard, matching the invoice or bill currency

currencyPairstring

The traded currency pair this guard is booked on, in CurrencyPair convention. The guard currency may be either leg of this pair.

payReceive'PAY' | 'RECEIVE'

Indicates whether the guard will pay or receive foreign currency

foreignAmountnumber

Amount of the guard in the foreign currency

totalForeignAmountSettlednumber

Total foreign amount settled so far in the foreign currency

guardRatenumber

Guard rate of exchange

paymentMarginAtInceptionnumber

Client payment margin inside the guard rate, frozen at inception, as a decimal (0.015 = 1.5%)

midAtInceptionnumber

CGL market mid the guard rate was derived from, copied from the guard quote

spotFxBidnumber

Spot FX bid rate at the time the guard was created, copied from the guard quote

spotFxAsknumber

Spot FX ask rate at the time the guard was created, copied from the guard quote

guardAmountnumber

Guard amount in the guard currency, derived from the foreign amount and guard rate

totalGuardAmountSettlednumber

Total guard amount settled so far in the guard currency

guardFeenumber

Fee paid for the guard in the guard currency

guardFeeDatestring

Guard fee payment date, calculated as trade_date + 2 business days. Corresponds to the premium payment date on the back-to-back hedge.

salesMarginRatenumber

Sales margin rate as a decimal (e.g. 0.007 = 0.7%). If only salesMarginRate is provided, salesMargin amount is calculated. If only salesMargin is provided, salesMarginRate is calculated. If both are provided, they must match within a tolerance of 0.01 or the request is rejected with 400 Bad Request.

salesMarginnumber

Sales margin amount incorporated into the guard fee and expressed in guard currency. If only salesMargin is provided, salesMarginRate is calculated. If only salesMarginRate is provided, salesMargin amount is calculated. If both are provided, they must match within a tolerance of 0.01 or the request is rejected with 400 Bad Request.

effectiveRatenumber

Effective rate to the client after all costs including the Guard fee and margins

guardQuoteIdstring uuid

ID of the guard quote that was used to create this guard

versionNumberinteger

Strictly monotonically increasing version number for this record

updatedBystring

Username of the person or entity that updated this record

updatedAtstring

Timestamp when of the last update in UTC

createdAtstring

Timestamp of creation in UTC

expectedPaymentMarginnumber

Expected payment margin still to be earned on the unsettled portion of this guard, in guard currency

realizedPaymentMarginnumber

Realized payment margin from SETTLEMENT_EXECUTED settlements to date, net of true-ups, in guard currency

Example response

[
  {
    "id": "GSP1000104",
    "originalGuardId": "GSP1000104",
    "previousGuardId": "GSP1000104",
    "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
    "regulatedUserId": "9e107d9d-372d-4add-ae2d-f3d1d41fd1d7",
    "salesUserId": "9e107d9d-372d-4add-ae2d-f3d1d41fd1d7",
    "companyId": "9e107d9d-372d-4add-ae2d-f3d1d41fd1d7",
    "customerId": "9e107d9d-372d-4add-ae2d-f3d1d41fd1d7",
    "guardStatus": "ACTIVE",
    "externalRef": "BEN-90210",
    "invoiceExternalRef": "INV-2024-001",
    "guardPeriodFrom": "2024-01-16",
    "tradeDate": "2024-01-16T11:00:00Z",
    "settlementWindowFrom": "2024-01-16",
    "settlementWindowTo": "2024-04-15",
    "guardCurrency": "GBP",
    "foreignCurrency": "USD",
    "currencyPair": "GBPUSD",
    "payReceive": "PAY",
    "foreignAmount": 50000,
    "totalForeignAmountSettled": 15000,
    "guardRate": 1.3121,
    "paymentMarginAtInception": 0.015,
    "midAtInception": 1.34,
    "spotFxBid": 1.3115,
    "spotFxAsk": 1.3125,
    "guardAmount": 38109.75,
    "totalGuardAmountSettled": 11432.92,
    "guardFee": 512,
    "guardFeeDate": "2024-01-18",
    "salesMarginRate": 0.007,
    "salesMargin": 296.02,
    "effectiveRate": 1.2946,
    "guardQuoteId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z",
    "expectedPaymentMargin": 1250.5,
    "realizedPaymentMargin": 875.25
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.