v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
InstantSettlement

Create a transaction

When a 4xx client error occurs, response body may have schema YL.Domain.Messages.ResultWrapper and contain more details on the error.<br /><br /><b>Possible values of YL.Domain.Messages.ResultWrapper.ErrorType for this endpoint:</b><br /><br /><b>2</b> - Instant settlement not found<br /><b>4</b> - Attempted to create a transaction on an Instant Settlement for which automatic creation of loans is disabled.<br /><b>5</b> - CurrencyISOCode for the requested transaction does not match the CurrencyISOCode on the Instant Settlement.<br /><b>6</b> - Attempted to create transaction with YL.Web.Api.ThirdParty.Loan.InstantSettlement.Models.CreateInstantSettlementTransactionModel.TotalSettlementAmount equal to 0.<br /><b>7</b> - Attempted to create a transaction that was not from today.<br /><b>8</b> - The size of the requested transaction is too large.<br /><b>9</b> - A transaction with the same transaction reference has already been created recently (within last 50 created transactions).<br /><br /> Sample request: POST /api/InstantSettlement/30000001 { "transactionReference": "ref", "currencyISOCode": "GBP", "totalSettlementAmount": 10000, "transactionDate" : "2020-02-16T18:25:43-05:00" }

post/api/InstantSettlement/{instantSettlementNumber}

Path parameters

instantSettlementNumberinteger required

Instant settlement number (an integer)<br /><br /> This parameter can be obtained by calling the api/InstantSettlement GET endpoint which returns details about all instant settlement products available for a lending partner.

Headers

api-versionstring

Request body

transactionReferencestring required

Gets or sets a transaction reference that will be shown in the account where the funds are transfered. This is a string of maximum 35 characters (a-zA-Z0-9/-?:.+ blank/space). It needs to be unique for each transaction request.

currencyISOCodestring nullable

Gets or sets Currency ISO code string

totalSettlementAmountnumber double

Gets or sets Total settlement amount

transactionDatestring date-time

Gets or sets transaction date (needs to be within the settlement cycle length specified for each Instant Settlement)

Response

Instant settlement transaction successfully created

instantSettlementNumberinteger

Gets or sets the InstantSettlementNumber

instantSettlementTransactionNumberinteger

Gets or sets transaction number, a unique identifier of the transaction for the corresponding InstantSettlementNumber