POST v1/PaymentActivities/Resolve
Documentation for 'Resolve'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
entity | Documentation for 'entity'. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
Click to beautify!
{ "paymentId": 1, "paymentStatus": "sample string 2", "authorizationCode": "sample string 3", "secondaryTransactionNumber": "sample string 4", "forceFailResolution": true }
application/xml, text/xml
Sample:
Click to beautify!
<PaymentResolution xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post"> <AuthorizationCode>sample string 3</AuthorizationCode> <ForceFailResolution>true</ForceFailResolution> <PaymentId>1</PaymentId> <PaymentStatus>sample string 2</PaymentStatus> <SecondaryTransactionNumber>sample string 4</SecondaryTransactionNumber> </PaymentResolution>
application/x-www-form-urlencoded
Sample:
Click to beautify!
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "customerId": 1, "status": "sample string 2", "effectiveTimestamp": "2024-05-03T14:57:32.5553581+00:00", "createdTimestamp": "2024-05-03T14:57:32.5553581+00:00", "source": "sample string 5", "method": "sample string 6", "transactionType": "sample string 7", "amount": 8.0, "gatewayFee": 1.0, "currency": "sample string 9", "transaction": { "paymentActivityId": 1, "reference": "sample string 2", "effectiveTimestamp": "2024-05-03T14:57:32.5553581+00:00", "referenceDate": "2024-05-03T14:57:32.5553581+00:00", "description": "sample string 4", "customerId": 5, "originalPaymentActivityId": 1, "amount": 6.0, "currency": "sample string 7", "invoiceAllocations": [ { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" }, { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" }, { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" } ], "refunds": [], "unallocatedAmount": 8.0, "refundableAmount": 1.0, "gatewayFee": 1.0, "settlement": { "status": "sample string 1", "modifiedTimestamp": "2024-05-03T14:57:32.5553581+00:00", "lastCheckedTimestamp": "2024-05-03T14:57:32.5553581+00:00", "nextCheckTimestamp": "2024-05-03T14:57:32.5553581+00:00", "message": "sample string 2" }, "netsuiteId": "sample string 9", "surchargingFee": 1.0, "sendToNetsuite": true, "quickBooksId": 1, "quickBooksAttemptNumber": 11, "id": 12, "uri": "sample string 13" }, "methodIsAch": false, "parentCustomerId": 1, "reconciliationId": "bf954e95-d41f-4978-86b1-82fbf8e615bf", "trigger": "sample string 10", "triggeringUserId": 1, "attemptNumber": 11, "customer": { "id": 1, "firstName": "sample string 2", "lastName": "sample string 3", "companyName": "sample string 4", "reference": "sample string 5", "reference1": "sample string 6", "reference2": "sample string 7", "reference3": "sample string 8", "salesTrackingCodes": [ { "type": "sample string 1", "code": "sample string 2", "name": "sample string 3", "id": 4, "uri": "sample string 5" }, { "type": "sample string 1", "code": "sample string 2", "name": "sample string 3", "id": 4, "uri": "sample string 5" }, { "type": "sample string 1", "code": "sample string 2", "name": "sample string 3", "id": 4, "uri": "sample string 5" } ] }, "paymentMethod": { "id": 1, "firstName": "sample string 2", "lastName": "sample string 3", "firstSix": "sample string 4", "lastFour": "sample string 5", "cardType": "sample string 6", "expirationMonth": 1, "expirationYear": 1, "maskedAccountNumber": "sample string 7", "maskedTransitNumber": "sample string 8", "bankAccountType": "sample string 9", "externalCustomerId": "sample string 10", "externalCardId": "sample string 11" }, "invoices": [ { "invoiceId": 1, "invoiceNumber": 2, "invoiceAmount": 3.0, "invoiceTotal": 4.0, "taxes": 5.0, "discounts": 6.0, "chargeGroups": [ { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] } ] }, { "invoiceId": 1, "invoiceNumber": 2, "invoiceAmount": 3.0, "invoiceTotal": 4.0, "taxes": 5.0, "discounts": 6.0, "chargeGroups": [ { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] } ] }, { "invoiceId": 1, "invoiceNumber": 2, "invoiceAmount": 3.0, "invoiceTotal": 4.0, "taxes": 5.0, "discounts": 6.0, "chargeGroups": [ { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] }, { "subscriptionId": 1, "name": "sample string 1", "description": "sample string 2", "reference": "sample string 3", "code": "sample string 4", "charges": [ { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" }, { "chargeId": 1, "subscriptionProductId": 1, "quantity": 2.0, "amount": 3.0, "name": "sample string 4", "description": "sample string 5", "code": "sample string 6" } ], "customFields": [ { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} }, { "key": "sample string 1", "friendlyName": "sample string 2", "dataType": "sample string 3", "value": {} } ], "coupons": [ { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" }, { "subscriptionId": 1, "couponCode": "sample string 2", "sideEffects": {}, "id": 3, "uri": "sample string 4" } ] } ] } ], "id": 12, "uri": "sample string 13" }
application/xml
Sample:
Click to beautify!
Sample not available.
text/xml
Sample:
Click to beautify!
Sample not available.