Charge — XPay docs

A Charge represents one attempt to move money from a customer's payment method. PaymentIntent retries create separate charges; refunds reference the charge they reverse.

id*string

object*"charge"

Value in

"charge"

amount*number

amountCaptured*number

amountRefunded*number

currency*string

Value in

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

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

status*string

Value in

"SUCCEEDED"
"PENDING"
"FAILED"
"CANCELED"
"REFUNDED"
"PARTIALLY_REFUNDED"

paid*boolean

refunded*boolean

captured*boolean

capturedAt*|

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

failureCode*string|null

failureMessage*string|null

receiptUrl*string|null

receiptEmail*string|null

billingDetails*

paymentMethodDetails*|null

outcome*|null

balanceTransaction*|null

presentmentDetails*|

Present when customer paid in a different currency than settlement (EGP)

refunds*array<>

Refunds issued against this charge, ordered newest-first.

paymentIntentId*string

paymentMethodId*string|null

calculatedStatementDescriptor*string|null

disputed*boolean

externalChargeId*string|null

config*|null

geocoding*|null

session*|null

merchantOrigin*|

Origin of the checkout page; null for merchant-initiated charges.

merchantDomain*|

Registrable domain derived from merchantOrigin.

processorCapabilities*|null

activeHoldId*string|null

settlementModel*string

Value in

"aggregated"
"direct"

{  "id": "string",  "object": "charge",  "amount": 0,  "amountCaptured": 0,  "amountRefunded": 0,  "currency": "EGP",  "createdAt": "2019-08-24T14:15:22Z",  "status": "SUCCEEDED",  "paid": true,  "refunded": true,  "captured": true,  "capturedAt": "2019-08-24T14:15:22Z",  "failureCode": "string",  "failureMessage": "string",  "receiptUrl": "string",  "receiptEmail": "string",  "billingDetails": {    "address": {      "city": "string",      "country": "string",      "line1": "string",      "line2": "string",      "postalCode": "string",      "state": "string"    },    "email": "string",    "name": "string",    "phone": "string"  },  "paymentMethodDetails": {    "type": "string",    "card": {      "brand": "string",      "country": "string",      "expMonth": 0,      "expYear": 0,      "funding": "string",      "last4": "string",      "network": "string",      "fingerprint": "string",      "threeDSecure": {},      "wallet": {}    },    "valu": {      "loanNumber": "string",      "tenure": 0,      "emi": "string",      "downPayment": "string",      "financedAmount": "string",      "firstEmiDueDate": "string",      "lastInstallmentDate": "string"    },    "fawry": {      "fawryRefNumber": "string",      "paymentReferenceNumber": "string",      "paymentMethod": "string",      "paymentTime": 0,      "expiresAt": "2019-08-24T14:15:22Z"    }  },  "outcome": {    "networkStatus": "string",    "reason": "string",    "riskLevel": "string",    "riskScore": 0,    "sellerMessage": "string",    "type": "string"  },  "balanceTransaction": {    "id": "string",    "object": "balance_transaction",    "amount": 0,    "availableOn": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "currency": "EGP",    "description": "string",    "fee": 0,    "net": 0,    "feeDetails": [      {}    ],    "status": "AVAILABLE",    "type": "CHARGE",    "reportingCategory": "string",    "exchangeRate": 0,    "source": "string",    "payoutBatch": {      "id": "string",      "object": "payout_batch",      "amount": 0,      "currency": "EGP",      "status": "open",      "arrivalDate": "2019-08-24",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "paymentIntentId": "string",    "merchantId": "string"  },  "presentmentDetails": {    "amount": 0,    "currency": "EGP",    "exchangeRate": 0,    "exchangeRateId": "string"  },  "refunds": [    {      "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": {},      "status": "PENDING",      "reason": "DUPLICATE",      "failureReason": "lost_or_stolen_card",      "failureCode": "string",      "failureMessage": "string",      "pendingReason": "processing",      "description": "string",      "destinationDetails": {},      "nextAction": {},      "instructionsEmail": "string",      "receiptNumber": "string",      "feeAmount": 0    }  ],  "paymentIntentId": "string",  "paymentMethodId": "string",  "calculatedStatementDescriptor": "string",  "disputed": true,  "externalChargeId": "string",  "config": {    "vatCollectionEnabled": true,    "vatCollectionRate": 0,    "collectedVatAmount": 0,    "platformFeePassThrough": true,    "merchantFeeDeduction": 0  },  "geocoding": {    "ipAddress": "string",    "location": {      "countryCode": "string",      "countryName": "string",      "regionCode": "string",      "regionName": "string",      "cityName": "string"    }  },  "session": {    "browser": "string",    "browserVersion": "string",    "platform": "string",    "device": "string",    "deviceVendor": "string",    "deviceModel": "string"  },  "merchantOrigin": "string",  "merchantDomain": "string",  "processorCapabilities": {    "supportsRefund": true,    "supportsPartialRefund": true  },  "activeHoldId": "string",  "settlementModel": "aggregated"}