The instruction that should be used for transferring money to the customer. This field is required if method is not provided. If both are specified, this will be preferred over the method input.

ledgerId : String

The ledger id from which the repayment will be requested.

Deprecation

The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.

ledgerNumber : String

The ledger number from which the repayment will be requested.

method : RequestableRepaymentMethod

The method by which the money will be transferred to the customer. This field is required if instruction_reference is not provided.

reason : String

The reason for the repayment.

reasonCode : RepaymentReason

The reason code classifying the repayment request. Defaults to PARTIAL_CREDIT_REFUND if not provided.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{
  "accountNumber": "A-6D6881AD",
  "amountInMinorUnit": 28,
  "idempotencyKey": "machine-song-should-half-factor",
  "instructionReference": "choose-somebody-strategy-if-with",
  "ledgerNumber": "certain-far-reach-police-well",
  "method": "BANK_TRANSFER",
  "reason": "Mr-act-spring-car-section",
  "reasonCode": "BILLING_ADJUSTMENT"
}