@mollie/api-client/dist/types/data/chargebacks/Chargeback.d.ts

Official Mollie API client for Node

import type TransformingNetworkClient from '../../communication/TransformingNetworkClient';
import type Seal from '../../types/Seal';
import { type Amount, type Links, type Url } from '../global';
import type Helper from '../Helper';
import type Model from '../Model';
import { type PaymentData } from '../payments/data';
import type Payment from '../payments/Payment';
export interface ChargebackData extends Model<'chargeback'> {
    /**
     * The amount charged back by the consumer.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=amount#response
     */
    amount: Amount;
    /**
     * This optional field will contain the amount that will be deducted from your account, converted to the currency your account is settled in. It follows the same syntax as the `amount` property.
     *
     * Note that for chargebacks, the `value` key of `settlementAmount` will be negative.
     *
     * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal chargebacks.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=settlementAmount#response
     */
    settlementAmount: Amount;
    /**
     * The date and time the chargeback was issued, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=createdAt#response
     */
    createdAt: string;
    /**
     * Reason for the chargeback as given by the bank.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=reason#response
     */
    reason: {
        /**
         * Bank code of the chargeback reason.
         *
         * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=reason/code#response
         */
        code: string;
        /**
         * Detailed description of the reason.
         *
         * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=reason/description#response
         */
        description: string;
    };
    /**
     * The date and time the chargeback was reversed if applicable, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=reversedAt#response
     */
    reversedAt: string;
    /**
     * The unique identifier of the payment this chargeback was issued for. For example: `tr_7UhSN1zuXS`. The full payment object can be retrieved via the `payment` URL in the `_links` object.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=paymentId#response
     */
    paymentId: string;
    _embedded?: {
        payment?: Omit<PaymentData, '_embedded'>;
    };
    /**
     * An object with several URL objects relevant to the chargeback. Every URL object will contain an `href` and a `type` field.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=_links#response
     */
    _links: ChargebackLinks;
}
type Chargeback = Seal<Omit<ChargebackData, '_embedded'> & {
    _embedded?: {
        payment?: Payment;
    };
}, Helper<ChargebackData, Chargeback>>;
export default Chargeback;
export interface ChargebackLinks extends Links {
    /**
     * The API resource URL of the payment this chargeback belongs to.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=_links/payment#response
     */
    payment: Url;
    /**
     * The API resource URL of the settlement this payment has been settled with. Not present if not yet settled.
     *
     * @see https://docs.mollie.com/reference/v2/chargebacks-api/get-payment-chargeback?path=_links/settlement#response
     */
    settlement?: Url;
}
export declare enum ChargebackEmbed {
    payment = "payment"
}
export declare function transform(networkClient: TransformingNetworkClient, input: ChargebackData): Chargeback;