@agorio/sdkDocs


Interface: RefundMandate

RefundMandate — refund flow counterpart to IntentMandate. (v0.9)

Issued by the buyer’s agent (or the merchant’s automated refund flow) to authorize money moving back to the buyer. Shares the IntentMandate base fields and adds the original mandate it refunds plus an optional reason.

Extends

Properties

amount

amount: string

Total amount to be charged

Inherited from

IntentMandate.amount

Defined in

src/client/ap2-client.ts:30


createdAt

createdAt: string

ISO-8601 creation timestamp

Inherited from

IntentMandate.createdAt

Defined in

src/client/ap2-client.ts:35


currency

currency: string

Inherited from

IntentMandate.currency

Defined in

src/client/ap2-client.ts:31


expiresAt

expiresAt: number

Unix timestamp (ms) at which this mandate expires

Inherited from

IntentMandate.expiresAt

Defined in

src/client/ap2-client.ts:33


mandateId

mandateId: string

Unique mandate identifier

Inherited from

IntentMandate.mandateId

Defined in

src/client/ap2-client.ts:26


merchantId

merchantId: string

Merchant receiving the payment

Inherited from

IntentMandate.merchantId

Defined in

src/client/ap2-client.ts:28


originalMandateId

originalMandateId: string

mandateId of the original IntentMandate / CartMandate being refunded.

Defined in

src/client/ap2-client.ts:61


reason?

optional reason: string

Optional human-readable reason.

Defined in

src/client/ap2-client.ts:63