Credit Line APIs

API Definitions

Transaction Hold

Request a purchase hold.

note: any funds held in this way will be considered unavailable for future hold requests until either this hold is canceled, or the transaction is marked as repaid.

Endpoint

POST: https://sandbox-api.upwardli.com/v2/credit-line/{credit_line_id}/hold/

Request

The request object for a hold contains the amount you wish to create a hold for.

1
{
2
    "amount": 123.45
3
}

Response

If the end user has sufficient funds in their account

1
{
2
    "amount": 123.45,
3
    "transaction_id": "00000000-0000-0000-0000-000000000000",
4
    "credit_line_status": "active"
5
}

Transaction Clear

Clear the Transaction to disburse funds on behalf of the end user.

Endpoint

POST: https://sandbox-api.upwardli.com/v2/credit-line/{credit_line_id}/transactions/{transaction_id}/clear

Response

1
{
2
    "success": true
3
}

Transaction Close

Close the transaction and extinguish the liability.

Endpoint

POST https://sandbox-api.upwardli.com/v2/credit-line/{credit_line_id}/transactions/{transaction_id}/close

Response

1
{
2
    "success": true
3
}

Cancel a Transaction

Cancel a transaction so that the funds are released back to the consumer and available for spending. You can cancel a transaction in any of the following states:

1. An initial hold can be canceled. This will release the hold immediately.
2. A transaction that has been cleared can be canceled. We will undo the transaction and mark it as closed, but it will not be reported to the bureaus.
3. A transaction that has been closed can be canceled. We will undo the transaction and mark it as closed, but it will not be reported to the bureaus.

Endpoint

POST https://sandbox-api.upwardli.com/v2/credit-line/{credit_line_id}/transactions/{transaction_id}/cancel

Response

1
{
2
    "success": true
3
}

Get Credit-Line Details

Get the current credit-line details

Endpoint

POST https://api-sandbox.upwardli.com/v2/credit-line/{credit_line_id}/

Response (example)

1
{
2
    "id": "4a0c41db-b2ca-4191-8df3-e733ecee5d14", 
3
    "consumer_id": "abcdef12-ab12-ab12-ab12-abcdef12abc1",
4
    "current_status": "active",
5
    "outstanding_balance": 0.0,
6
    "approved_loan_amount": 600.0
7
}