Developers
API referenceBusiness sign in

Schema

ReturnPolicy

The return policy in force (store, else Business, else default), after any contract terms.

Fields

ReturnPolicy fields
FieldTypeDescription
sourceRequiredenumOne of DEFAULT, BUSINESS, STORE
idOptionalstring or null
versionOptionalinteger
statusRequiredenumOne of ACTIVE, DISABLED
windowDaysRequiredinteger
reasonsRequiredarray of ReturnReason
payerRequiredReturnPayerMERCHANT: billed to your Business wallet or invoice. CUSTOMER: the customer pays by Mobile Money before the code works. DEDUCT_FROM_REFUND: billed to you; deductFromRefundMinor tells your refund system what to keep back.
merchantPaymentModeOptionalenumOne of BUSINESS_WALLET, BUSINESS_INVOICE
allowedProductsRequiredarray of ReturnProduct
approvalModeRequiredenumOne of AUTO, MANUAL
maxValueMinorOptionalinteger or null
returnPointCodeOptionalstring or null
returnPointNameOptionalstring or null
returnAddressOptionalobject or null
textOptionalstring
returnContactOptionalobject or null
nameOptionalstring
phoneOptionalstring
instructionsOptionalstring or null
contractOptionalobject or null
idOptionalstring
overridesOptionalarray of string

Used by