/order/{key}/refund

post https://example.com/order/{key}/refund

Refund a full or partial amount of an order. A date can be provided to back-dated the refund.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

key

string

The unique order key generated by Credit Key.

company_id

string

The ID of the company that has a credit application with Credit Key.

merchant_order_id

string

An optional unique order ID provided by merchants.

installments

number

The number of loan payment installments for this order.

amount

number

The total amount for this order in USD.

amount_refunded

number

The total amount refunded for this order in USD.

expected_repay_amount

number

The total expected repayment amount including principal, interest and fees for this order in USD.

expected_fee_amount

number

The total amount of interest and fees for this order in USD.

expected_fee_percent

number

The total amount of interest and fees as a percentage for this order.

capture_date

string

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

next_payment_date

string

The date of the next expected order payment according to its loan schedule.

payment_schedule

array of objects

The loan repayment schedule for this order.

payment_schedule

object

installment

number

The installment schedule number.

date

string

The installment due date.

amount

number

The total amount for this installment in USD.

principal_amount

number

The principal amount for this installment in USD.

interest_amount

number

The interest amount for this installment in USD.

fee_amount

number

The fee amount for this installment in USD.

externally_managed_payments

boolean

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

created_at

string

The date and time the order was created in UTC.

status

string

The current status of the order.

CREATED AUTHORIZED CANCELED CAPTURED RETURNED PENDING FAILED

reasons

array of strings

A list of reasons why the order has failed.

reasons

approved_terms

array of objects

List of all available payment terms for this order.

approved_terms

object

installments

number

The total number of monthly installments for this loan.

interest_rate

number

The interest rate for loans with this number of installments.

monthly_payment

number

The monthly payment amount of each installment in USD.

total_fees

number

The total fees amount for this loan in USD.

total_fees_percent

number

The total fees as a percentage for this loan.

total_amount

number

The total amount including all interest and fees for this loan in USD.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/order/key/refund \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

201Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found