API Reference

post

post
https://api-sandbox.caddipay.com/v1/refund-order

Create an adjustment or refund against a particular order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

❗️

BETA API

This is a BETA API not available to all merchants. Please speak to your Caddipay account manager before beginning an integration.

Body Params
string
required

The orderToken the adjustment or refund should be applied to

string
enum
required

Use VOID to reduce the total amount of a loan. Use REFUND to return captured amounts.

Allowed:
double
required

The total amount of the void or refund

string

For REFUND requests - The fundingReference that is returned from calls to ship-order

string

Optionally, your unique reference id for this adjustment or refund which will be provided in settlement reports

merchantMetadata
object

Optionally, additional metadata which will be provided in settlement reports

Response

Updated over 2 years ago

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

Updated over 2 years ago