GuidesAPI Reference
API Reference

/v1/order/{key}

patch
https://example.com/v1/order/

Update an existing order.

The order status lifecycle is as follows: CREATED: The initial status of a validated order. AUTHORIZED: After the installments value (i.e. a loan term) has been submitted, the order may be AUTHORIZED. CANCELED: Cancels an order currently in AUTHORIZED status. CAPTURED: This will finalize the order and start the clock for repayment. First payment will be 31 days from this event. RETURNED: Only allowed on a CAPTURED order. Results in the reversal of all settled funds and all payments made to date.

Path Params
string
required

The unique order key generated by Credit Key.

Body Params
number

The total number of monthly installments for the order's loan repayment.

number

The total amount for this order in USD.

string

An optional unique order ID provided by merchants.

string

The expected date the order will be captured by the merchant. (Will be overridden by the actual loan disbursement date.)

boolean

If payments are to be handled externally by the merchant or internally by Credit Key.

string
enum

The new status for the order.

Allowed:
Responses

Updated 4 months ago

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