Edit a Loan

patch

https://api.sandbox.helloaria.eu/companies/{companyId}/loans/{loanId}

Note: Only works when Loan is in CREATED state! proofIds is not accepted here, it is a creation-only field: once the object exists, evidence is added through POST /companies/{companyId}/proofs and linked through POST /companies/{companyId}/proofs/{proofId}/link. The deprecated attachments field is still accepted and still replaces the list, see the field description for how it maps onto proofs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Defaults to me

loanId

string

required

Body Params

amount

number

Amount to be paid to the beneficiary. May differ from invoice amount.

currency

string

enum

Allowed:

userId

string

length ≥ 1

Unique Id of the User (beneficiary) being paid.

invoiceId

uuid | null

Unique Id of the Invoice.

receivableId

uuid | null

Unique Id of the Receivable. Only use this if you created a Receivable yourself.

paymentDestination

Bank account where Aria will send the funds. Required when currency is USD (and any future currency outside EUR/GBP/CHF); for those three currencies it can be omitted to fall back on the User's existing payment destinations. Will also upsert the provided destination on the User.

externalId

string

length ≥ 1

Optional identifier of your choosing

payoutLabel

string

Optional label, will be mentioned as a bank transfer reference.

paymentReconciliationId

uuid | null

attachments

array of objects

deprecated

Deprecated, use proofIds on creation or the proof endpoints instead. Lists the non-archived proofs linked to this Loan with source: COMPANY. On PATCH the list you send replaces the current one: a new file becomes a proof of type: UNKNOWN, a dropped one is archived. Omit the field and nothing changes. See the Proof guide.

attachments

guarantor

string

enum

Specifies the role of the entity assuming financial responsibility for the Loan. Set this field to company if you wish to act as the guarantor for the Loan. Our teams will be notified. This feature is disabled by default and needs to be activated on your account.

Allowed:

quoteOfferId

uuid

Id of an offer that was returned in a Quote you created.

preferInstantPayment

boolean | null

Specifies whether to enable instant payment for transactions in EUR. This feature requires prior activation. Please contact your Key Account Manager to enable this feature and for further assistance.

payoutIBAN

string

deprecated

To fill if you want to override the default User IBAN. Must match IBAN European format.

metadata

object | null

We may ask you to provide specific properties in this field to enable automation on our side. If we activate this in your account, the required format and properties are defined with you during onboarding.

Headers

x-end-user-ip

string

IP of the end-user doing the action resulting in the API call.

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200Successfully edited Loan

400Invalid payload, including any attempt to set proofIds on an existing object

403Not permitted (e.g trying to create a Loan for a company other than yours)

404Loan not found

409Conflict (i.e total amount of created Loans > amount of linked Invoice). PROOF_LOCKED if a Loan on this object is in any status other than CREATED, which locks its proofs.