Refund — XPay docs

A Refund returns funds from a successful Charge to the original payment method. It can be full or partial. Its status tracks the processor's progress; pending or requires_action does not mean funds have been returned.

id*string

Unique identifier for the refund

object*"refund"

Value in

"refund"

amount*number

Refund amount in the smallest currency unit

chargeId*string

ID of the charge being refunded

paymentIntentId*string

ID of the PaymentIntent being refunded

balanceTransactionId*|

Refund balance transaction; null until settled

failureBalanceTransactionId*|

Failed refund reversal balance transaction, if any

externalRefundId*|

Processor refund ID, if reconciled

createdAt*string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Formatdate-time

currency*string

Value in

"EGP"
"USD"
"EUR"
"GBP"
"SAR"
"AED"
"QAR"
"KWD"
"JOD"
"OMR"
"BHD"
"LYD"
"AUD"
"CAD"
"CNY"

presentmentDetails?

status*string

Value in

"PENDING"
"REQUIRES_ACTION"
"SUCCEEDED"
"FAILED"
"CANCELED"

reason?|

Value in

"DUPLICATE"
"FRAUDULENT"
"REQUESTED_BY_CUSTOMER"
"RISK_HOLD_CAPTURE"

failureReason?|

Value in

"lost_or_stolen_card"
"expired_or_canceled_card"
"charge_for_pending_refund_disputed"
"insufficient_funds"
"declined"
"merchant_request"
"unknown"

failureCode?string|null

failureMessage?string|null

pendingReason?|

Value in

"processing"
"insufficient_funds"
"charge_pending"

description?string|null

destinationDetails?

nextAction?

instructionsEmail?string|null

receiptNumber?string

feeAmount?number

Original platform fee; kept by the platform, not refunded

{  "id": "string",  "object": "refund",  "amount": 0,  "chargeId": "string",  "paymentIntentId": "string",  "balanceTransactionId": "string",  "failureBalanceTransactionId": "string",  "externalRefundId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "currency": "EGP",  "presentmentDetails": {    "amount": 0,    "currency": "EGP",    "exchangeRate": 0,    "exchangeRateId": "string"  },  "status": "PENDING",  "reason": "DUPLICATE",  "failureReason": "lost_or_stolen_card",  "failureCode": "string",  "failureMessage": "string",  "pendingReason": "processing",  "description": "string",  "destinationDetails": {    "type": "card",    "card": {      "reference": "string",      "referenceStatus": "pending",      "referenceType": "string",      "type": "pending"    },    "wallet": {      "reference": "string",      "provider": "string"    },    "bankTransfer": {      "reference": "string",      "referenceStatus": "pending"    },    "kiosk": {      "reference": "string",      "provider": "string"    }  },  "nextAction": {    "type": "display_details",    "displayDetails": {      "emailSentAt": "2019-08-24T14:15:22Z",      "emailSentTo": "string",      "expiresAt": "2019-08-24T14:15:22Z"    }  },  "instructionsEmail": "string",  "receiptNumber": "string",  "feeAmount": 0}