Skip to main content

paymentHandlesList

paymentHandlesobject[]
meta object

Contains meta info for the pagination APIs

numberOfRecordsnumber

This is the number of records returned in the lookup.

Example: 1
limitnumber

This is the number of records returned per page.

Example: 10
pagenumber

This is the page of records on which the lookup starts.

Example: 1
paymentHandlesList
{
"paymentHandles": [
{
"id": "26359efd-7cfb-4014-a13d-1724e3ff17fa",
"paymentHandleToken": "SCO3wKcIyLoQbQvw",
"txnTime": "2023-01-19T10:28:00Z",
"status": "INITIATED",
"liveMode": true,
"usage": "SINGLE_USE",
"action": "NONE",
"executionMode": "SYNCHRONOUS",
"timeToLiveSeconds": 0,
"gatewayResponse": {
"id": "string",
"processor": "string",
"code": "string",
"responseCode": "string",
"avsCode": "string",
"avsResponse": "MATCH",
"balanceResponse": "string",
"mid": "string",
"terminalId": "string",
"batchNumber": "string",
"seqNumber": "string",
"effectiveDate": "string",
"financingType": "string",
"plan": "string",
"gracePeriod": "string",
"term": "string",
"responseId": "string",
"requestId": "string",
"description": "string",
"authCode": "string",
"txnDateTime": "string",
"referenceNbr": "string",
"responseReasonCode": "string",
"cvvVerification": "MATCH",
"cvv2Result": "string",
"status": "string",
"orderId": "string",
"profile": {
"id": "string",
"status": "string",
"merchantCustomerId": "string",
"locale": "en_US",
"firstName": "Venkata Suresh",
"lastName": "Chagalamarri",
"email": "paysafe@gmail.com",
"phone": "1234567891",
"dateOfBirth": {
"day": 6,
"month": 5,
"year": 1998
},
"mobile": "9846573804",
"gender": "M",
"nationality": "Indian",
"identityDocuments": [
{
"identityDocuments": [
{
"type": "SOCIAL_SECURITY",
"documentNumber": "SSN123456"
},
{
"type": "PASSPORT",
"documentNumber": "1234567",
"issuingCountry": "USA",
"issuingCountrySubdvision": "SA",
"expiryDate": {
"month": 12,
"year": 2022
}
}
]
}
]
}
},
"gatewayReconciliationId": "8e13f7fe-4fd2-4f58-92da-89fc9c2ec29b",
"updatedTime": "2024-07-29T15:51:28.071Z",
"statusTime": "2024-07-29T15:51:28.071Z",
"links": {
"rel": "redirect_payment",
"href": "http://api.paysafe.com/card/redirect/372b5ee7-6360-4403-b444-164f8f1d2709",
"method": "GET"
},
"merchantRefNum": "merchantRefNum-101",
"transactionType": "PAYMENT",
"accountId": "9876543210",
"paymentType": "CARD",
"amount": 500,
"currencyCode": "USD",
"paymentHandleTokenFrom": "SCyGZDlUuZ9zxjyd",
"profile": {
"id": "string",
"status": "string",
"merchantCustomerId": "string",
"locale": "en_US",
"firstName": "Venkata Suresh",
"lastName": "Chagalamarri",
"email": "paysafe@gmail.com",
"phone": "1234567891",
"dateOfBirth": {
"day": 6,
"month": 5,
"year": 1998
},
"mobile": "9846573804",
"gender": "M",
"nationality": "Indian",
"identityDocuments": [
{
"identityDocuments": [
{
"type": "SOCIAL_SECURITY",
"documentNumber": "SSN123456"
},
{
"type": "PASSPORT",
"documentNumber": "1234567",
"issuingCountry": "USA",
"issuingCountrySubdvision": "SA",
"expiryDate": {
"month": 12,
"year": 2022
}
}
]
}
]
},
"billingDetails": {
"id": "string",
"status": "string",
"nickName": "Home",
"street": "Street",
"street1": "street1",
"street2": "street2",
"city": "Toronto",
"state": "ON",
"country": "CA",
"zip": "M5H 2N2",
"phone": "8765846321"
},
"splitpay": {
"linkedAccount": "123124124",
"amount": 505,
"percent": 5
},
"merchantDescriptor": {
"dynamicDescriptor": "OnlineStore",
"phone": "999-8888"
},
"returnLinks": {
"rel": "default",
"href": "https://US_commerce_site/payment/return/success",
"method": "GET"
},
"customerIp": "111.111.111.111",
"transactionIntent": {
"transactionIntent": "CRYPTO_ON_RAMP"
},
"singleUseCustomerToken": "string",
"threeDs": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deviceFingerprintingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantRefNum": "fc5b62df1202e491475d",
"process": true,
"merchantUrl": "https://api.qa.paysafe.com/checkout/v2/demo-store/index.html",
"deviceChannel": "BROWSER",
"requestorChallengePreference": "NO_PREFERENCE",
"messageCategory": "PAYMENT",
"transactionIntent": "GOODS_OR_SERVICE_PURCHASE",
"authenticationPurpose": "PAYMENT_TRANSACTION",
"billingCycle": {
"endDate": "2024-07-29",
"frequency": 0
},
"orderItemDetails": {
"preOrderItemAvailabilityDate": "2024-07-29",
"preOrderPurchaseIndicator": "MERCHANDISE_AVAILABLE",
"reorderItemsIndicator": "FIRST_TIME_ORDER",
"shippingIndicator": "SHIP_TO_BILLING_ADDRESS"
},
"purchasedGiftCardDetails": {
"amount": 1234,
"count": 2,
"currency": "USD"
},
"userAccountDetails": {
"addCardAttemptsForLastDay": 0,
"changedDate": "2024-07-29",
"changedRange": "DURING_TRANSACTION",
"createdDate": "2024-07-29",
"createdRange": "NO_ACCOUNT",
"passwordChangedDate": "2024-07-29",
"passwordChangedRange": "NO_CHANGE",
"suspiciousAccountActivity": true,
"totalPurchasesSixMonthCount": 0,
"transactionCountForPreviousDay": 0,
"transactionCountForPreviousYear": 0,
"shippingDetailsUsage": {
"cardHolderNameMatch": true,
"initialUsageDate": "2024-07-29",
"initialUsageRange": "CURRENT_TRANSACTION"
},
"userLogin": {
"authenticationMethod": "NO_LOGIN",
"data": "Some up to 2048 bytes undefined data",
"time": "2024-07-29T15:51:28.071Z"
},
"paymentAccountDetails": {
"createdRange": "NO_ACCOUNT",
"createdDate": "2024-07-29"
},
"priorThreeDSAuthentication": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"data": "Some up to 2048 bytes undefined data",
"method": "FRICTIONLESS_AUTHENTICATION",
"time": "2024-07-29T15:51:28.071Z"
},
"travelDetails": {
"isAirTravel": false,
"airlineCarrier": "string",
"departureDate": "2024-07-29",
"destination": "string",
"origin": "string",
"passengerFirstName": "string",
"passengerLastName": "string"
}
},
"priorThreeDSAuthentication": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"data": "Some up to 2048 bytes undefined data",
"method": "FRICTIONLESS_AUTHENTICATION",
"time": "2024-07-29T15:51:28.071Z"
},
"shippingDetailsUsage": {
"cardHolderNameMatch": true,
"initialUsageDate": "2024-07-29",
"initialUsageRange": "CURRENT_TRANSACTION"
},
"suspiciousAccountActivity": true,
"totalPurchasesSixMonthCount": 0,
"transactionCountForPreviousDay": 0,
"transactionCountForPreviousYear": 0,
"travelDetails": {
"isAirTravel": false,
"airlineCarrier": "string",
"departureDate": "2024-07-29",
"destination": "string",
"origin": "string",
"passengerFirstName": "string",
"passengerLastName": "string"
},
"userLogin": {
"authenticationMethod": "NO_LOGIN",
"data": "Some up to 2048 bytes undefined data",
"time": "2024-07-29T15:51:28.071Z"
},
"browserDetails": {
"acceptHeader": "string",
"colorDepthBits": "1",
"customerIp": "string",
"javaEnabled": true,
"javascriptEnabled": true,
"language": "string",
"screenHeight": 0,
"screenWidth": 0,
"timezoneOffset": 0,
"userAgent": "string"
},
"cavv": "string",
"eci": 0,
"status": "COMPLETED",
"threeDResult": "Y",
"txnTime": "string",
"directoryServerTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"threeDSecureVersion": "string",
"acsUrl": "string",
"payload": "string",
"sdkChallengePayload": "string",
"xid": "string",
"threeDEnrollment": "Y",
"maxAuthorizationsForInstalmentPayment": 0,
"electronicDelivery": {
"email": "example@example.com",
"isElectronicDelivery": true
},
"initialPurchaseTime": "string",
"amount": 0
},
"deviceDetails": {
"deviceId": "876313"
},
"shippingDetails": {
"shipMethod": "Vishnu",
"street": "20735 Stevens Creek Blvd",
"street2": "Montessori",
"city": "Cupertino",
"state": "ON",
"country": "CA",
"zip": "95014"
},
"wallet": {
"customerId": "string",
"fee": 0,
"feeSettlementCurrency": "USD",
"feeWalletId": "string",
"slipId": "string",
" customerAccount": {
"id": "string"
},
"risk": {
"customerRiskRating": 0,
"isScaPerformed": true,
"isCustomerIPTrusted": true,
"isBeneficiaryTrusted": true
}
},
"card": {
"cardNum": "4111111111111111",
"cardExpiry": {
"month": 12,
"year": 2022
},
"cvv": "string",
"holderName": "Suresh's card",
"cardType": "AM",
"lastDigits": "string",
"nickName": "string",
"cardBin": "411111"
}
}
],
"meta": {
"numberOfRecords": 1,
"limit": 10,
"page": 1
}
}