Creates an Issuing CreditRepayment object.
Parameters
- accountstringRequired
The connected account making the repayment.
- amountobjectRequired
The amount of the repayment
- amount.
currencyenumRequired Three-letter ISO currency code, in lowercase. Must be a supported currency.
- amount.
valueintegerRequired A positive integer representing the amount in the smallest currency unit for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
- instructed_
byobjectRequired Information about the entity that initiated the payment.
- instructed_by.
typeenumRequired Whether this API request should initiate a new payment or record a payment that has already been made.
Possible enum valuescredit_repayments_ api The repayment created by this API will initiate a new payment and credit the funds to your platform balance.
userThe repayment records an existing payment. Your platform balance will not be impacted.
- instructed_by.
credit_ repayments_ apiobjectRequired if `type` is `credit_repayments_api`. Additional details about payments instructed by this API.
- instructed_by.
credit_repayments_api. payment_ methodstringRequired The consumer’s payment method to be used for the repayment. Must be of type us_bank_account.
- instructed_by.
userobjectRequired if `type` is `user`. Additional details about existing repayments recorded by the user.
- instructed_by.
user. payment_ method_ typeenumRequired The type of payment method used to receive payment.
- instructed_by.
user. payment_ referencestringRequired An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
More parameters
- credit_
statement_ descriptorstring Statement descriptor to be shown on the cardholder’s credit statement for this repayment. Must be no longer than 255 characters.
- customerstringRequired when the repayment is instructed by the `credit_repayments_api`.
The Customer object associated with the payment method.
Returns
Returns an Issuing CreditRepayment object if creation succeeds.
{ "replaceMe": "REPLACE ME"}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc