API Reference
Start typing to search…

Edit a Loan

patch
https://api.sandbox.helloaria.eu/companies//loans/

Note: Only works when Loan is in CREATED state!

Path Params
string
required
Defaults to me
string
required
Body Params
number

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

string
enum
Allowed:
string
length ≥ 1

Unique Id of the User (beneficiary) being paid.

uuid

Unique Id of the Invoice.

uuid

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

Will upsert the list of paymentDestinations attached to the User.

string
length ≥ 1

Optional identifier of your choosing

string

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

uuid
attachments
array of objects

Optional purchase invoice uploaded with the Upload file endpoint, related to the Loan. You may send one if we asked you to during your onboarding process.

attachments
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:
uuid

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

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.

string
deprecated

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

metadata
object

We may ask you to provide specific properties in this field to enable automation on our side. The required format and properties will be defined during your onboarding process and can be retrieved via a GET request to /company (loanMetadataJsonSchema).

Headers
string

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

Responses

Updated 10 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago