XM
Members
Delete Payment
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-payment/cart/{cartId}/payment/{paymentId}
Copied!
Enables you to delete the payment added to the cart, by cart ID and payment ID.

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : path
Name : The 24 character cart ID (from the Add Items to Cart or Retrieve Cart by userAuthToken API) and the payment ID.
Required: true

Sample Request

1
GET https://{baseurl}/api-payment/cart/6101f13956bfd30008b1a33e/payment/6101f1b9b308be0009519f78
Copied!

Response

Response Code: 200
Message: OK
Description: You'll see this message when the cart details are successfully retrieved.
1
{
2
"_id": "6101f1b9b308be0009519f78",
3
"paymentDetails": {
4
"transactionDetails": {
5
"paymentType": "CARD_STRIPE",
6
"paymentToken": "pi_1JIMoIJxr7zyIFb9WymZbwir"
7
},
8
"paymentStatus": {
9
"cardHolderFullName": "First Last",
10
"paymentMethod": "visa",
11
"last4": "4242",
12
"amountCapturable": 1450500,
13
"status": "succeeded"
14
},
15
"amount": 14505,
16
"currency": "USD"
17
},
18
"billToAddress": {
19
"name": {
20
"first": "John",
21
"last": "Smith"
22
},
23
"phone": {
24
"number": "07780811973",
25
"kind": "mobile"
26
},
27
"email": "[email protected]",
28
"street1": "600 Congress Ave",
29
"street2": "suite 219",
30
"city": "Austin",
31
"state": "Tx",
32
"country": "US",
33
"zipCode": "10033"
34
},
35
"version": 0,
36
"isValid": false,
37
"cartId": "6101f13956bfd30008b1a33e",
38
"createdAt": "2021-07-29T00:09:29.905Z",
39
"updatedAt": "2021-07-29T17:46:45.258Z",
40
"__v": 0
41
}
Copied!
Error Code: 404
Message: Not found
Description: You will see this error when the specified ship-to ID doesn't exist in the system.
1
{
2
"code": "CART_NOT_FOUND",
3
"message": "Cart not found."
4
}
Copied!
Error Code: 500
Message: Internal Server Eror
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021 First updated
Last modified 1mo ago
Copy link
Contents
Change Log