API Reference

Create a withdrawal request

post
https://partner-api.froda.se/funding/v1/companies//withdrawal-requests

The company's credit limit must be approved before creating a withdrawal request. Additional internal validations occur both on arguments and resulting withdrawal request.

Path Params
uuid
required
Body Params
double
required
1 to 100000000

Requested loan amount.

string
enum
required
Allowed:
loan_duration
object
required
interest
object
required
double | null
1 to 100000000

The partner's fee for the loan. For example inspection fee of financed goods. If you don't have any additional fees this field should be omitted.

string
enum
required

Tells what a withdrawal request is intended for.

Allowed:
purpose_additional_questions
array of objects | null

Free text to describe the purpose of the withdrawal request. required in case of loan_purpose = other.

purpose_additional_questions
string | null

A callback URL that will be invoked when events related to the withdrawal request occur (e.g. status updates, assessment updates, etc...) Callback structure can be found at: https://docs.froda.se/docs/callbacks

string | null

A callback URL that will be invoked when something happens on the loan related to this withdrawal request, e.g when a payment is done. Callback structure can be found at: https://docs.froda.se/docs/callbacks

reference
object
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

404

The company could not be found.

Updated about 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 1 year ago