API ReferenceContracts
Approve Contract
This API call is the final step for Xe executing payouts, using this call will approve the contract.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
contractNumber*string
Query Parameters
accountNumber?string
Client account number
Response Body
application/json
application/json
curl -X POST "https://example.com/v2/contracts/string/approve"{ "contractType": "NotSpecified", "createdDate": "2019-08-24T14:15:22Z", "deliveryMethod": "BankAccount", "identifier": { "clientTransferNumber": "ACME1345", "contractNumber": "2416427" }, "quote": { "expires": "2019-08-24T14:15:22Z", "fxDetails": [ { "buy": { "amount": 80, "currency": "GBP" }, "fixedAmountType": "NotSet", "rate": { "baseCurrency": "GBP", "buyCurrency": "GBP", "inverseRate": 0, "rate": 0, "sellCurrency": "GBP" }, "remainingBuyForward": { "amount": 80, "currency": "GBP" }, "remainingSellForward": { "amount": 80, "currency": "GBP" }, "sell": { "amount": 80, "currency": "GBP" }, "effectiveDate": "2019-08-24", "quoteType": "Spot", "remainingToDisburse": { "amount": 80, "currency": "GBP" }, "valueDate": "2019-08-24" } ], "quoteTime": "2019-08-24T14:15:22Z" }, "quoteStatus": "NotSet", "settlementOptions": [ { "displayName": "string", "initialMarginSettlementMethods": [ "BankTransfer" ], "isAvailable": true, "method": "BankTransfer", "unAvailableReason": "string", "unAvailableReasonCode": "string" } ], "settlementStatus": "Settled", "status": "QuoteRequired", "summary": [ { "directDebitBankAccount": { "accountName": "ACME", "accountNumber": "12345674" }, "settlementDate": "2019-08-24T14:15:22Z", "settlementMethod": "BankTransfer", "xeBankAccount": { "accountName": "ACME", "accountNumber": "12345674", "accountType": "string", "bic": "MIDLGB22XXX", "branchNumber": "string", "country": "GB", "iban": "GB26MIDL40051512345674", "ncc": "string" }, "initialMargin": { "amount": 0, "currency": "GBP" }, "remainingSettlement": { "amount": 0, "currency": "GBP", "valueDate": "2019-08-24" }, "settlementAmount": { "amount": 0, "currency": "GBP" }, "settlementFees": { "amount": 0, "currency": "GBP" } } ]}{ "code": 0, "failureDateTime": "2019-08-24T14:15:22Z", "longErrorMsg": "string", "shortErrorMsg": "string", "traceErrorId": "string", "typeOfFailure": "MODEL_VALIDATION"}Empty
Empty
Empty