Refund
Fields every transaction has — payin, refund and payout.
objectandmethod_typetell which fields come on top; the fields of the payment instrument are in an object named after it —card,apple_payorgoogle_pay.- Properties: 2amountType:required
- createdType: stringFormat: date-time
_at requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- idType: stringFormat: uuidrequired
Transaction id. The type of the transaction is in
object. - merchantType:
_reference min length:1max length:100requiredYour id for the transaction, unique per merchant across payins, refunds, payouts and pay sessions. It is also the idempotency key of the create — the same reference with the same body returns the existing transaction, with a different body
409 merchant_reference_conflict. Never expires. - method
_type const:refundrequired - objectconst:refundrequired
- payinType: string
_id requiredThe payin this refund returns money from.
- statusType: enumrequiredvalues
- created
Recorded. Not final.
- processing
At the provider. Not final.
- completed
Returned to the payer. Final.
- failed
Not returned — read
status_details.code. Final.
- created
- statusType: nullable
_details requiredProperties: 2Why the transaction ended
failed.nullin every other status. - updatedType: stringFormat: date-time
_at requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z