SellerPayoutBatchPayment
Type: schema
Description
Transfer recorded on a SellerPayoutBatch. Mirrors OrderPayment, with payout settlement field types.
TypeScript Definition
typescript
SellerPayoutBatchPayment: {{
/** @enum {unknown} */
transaction_type?: "payment" | "refund";
request_number?: string;
/** @description Transfer amount as a decimal string. */
amount?: string;
/**
* @description Status of the transfer: `pending` until it is sent, `initiated` once the bank has accepted it and its confirmation is awaited, `success` once paid, `failed` when the attempt failed (it is retried until its retries are used up).
* @enum {string}
*/
payment_status?: "pending" | "initiated" | "success" | "failed";
/** Format: date-time */
payment_date?: string | null;
/** @description When the transfer succeeded. */
payment_success_date?: string | null;
payment_reference_number?: string | null;
/**
* @description Empty string when recorded without a method; null for refunds.
* @enum {string|null}
*/
payment_method?: "Card" | "Credit Card" | "Debit Card" | "Netbanking" | "UPI" | "Wallet" | "Loyalty Point" | "IMPS" | "NEFT" | "RTGS" | "Cash" | "NACH" | "" | null;
payment_mode?: string;
icon_url?: string | null;
/** @description Masked card number, e.g. ************1111. Card payments only. */
card_number?: string | null;
/** @enum {string|null} */
card_type?: "Visa" | "Master Card" | "Rupay" | null;
bank_name?: string | null;
/** @description Masked account number, e.g. ************1234. */
bank_account_number?: string | null;
};
/** SellerPayoutCharge */
}OpenAPI Schema
json
{
"title": "SellerPayoutBatchPayment",
"description": "Transfer recorded on a `SellerPayoutBatch`. Mirrors `OrderPayment`, with payout settlement field types.",
"type": "object",
"properties": {
"transaction_type": {
"enum": [
"payment",
"refund"
]
},
"request_number": {
"type": "string"
},
"amount": {
"description": "Transfer amount as a decimal string.",
"type": "string"
},
"payment_status": {
"description": "Status of the transfer: `pending` until it is sent, `initiated` once the bank has accepted it and its confirmation is awaited, `success` once paid, `failed` when the attempt failed (it is retried until its retries are used up).",
"type": "string",
"enum": [
"pending",
"initiated",
"success",
"failed"
]
},
"payment_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"payment_success_date": {
"description": "When the transfer succeeded.",
"type": [
"string",
"null"
]
},
"payment_reference_number": {
"type": [
"string",
"null"
]
},
"payment_method": {
"description": "Empty string when recorded without a method; null for refunds.",
"type": [
"string",
"null"
],
"enum": [
"Card",
"Credit Card",
"Debit Card",
"Netbanking",
"UPI",
"Wallet",
"Loyalty Point",
"IMPS",
"NEFT",
"RTGS",
"Cash",
"NACH",
"",
null
]
},
"payment_mode": {
"type": "string"
},
"icon_url": {
"type": [
"string",
"null"
]
},
"card_number": {
"description": "Masked card number, e.g. ************1111. Card payments only.",
"type": [
"string",
"null"
]
},
"card_type": {
"type": [
"string",
"null"
],
"enum": [
"Visa",
"Master Card",
"Rupay",
null
]
},
"bank_name": {
"type": [
"string",
"null"
]
},
"bank_account_number": {
"description": "Masked account number, e.g. ************1234.",
"type": [
"string",
"null"
]
}
},
"x-tags": [
"Payouts"
]
}Auto-generated from OpenAPI spec and TypeScript definitions