Delete payment

curl --request DELETE \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId} \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}"

headers = {"x-site-context": "<x-site-context>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'x-site-context': '<x-site-context>'}};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}")
  .header("x-site-context", "<x-site-context>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-site-context"] = '<x-site-context>'

response = http.request(request)
puts response.read_body

{
  "billToAddress": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "user1@gmail.com",
    "phone": {
      "number": "3334445555",
      "kind": "Mobile"
    },
    "street1": "1000 main street",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "zipCode": "98101",
    "street2": "1000 main street"
  },
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z",
  "paymentDetails": {
    "transactionDetails": {
      "paymentType": "CARD_STRIPE",
      "paymentToken": "pi_1IyMGc2YBvYaVyBQNkOiCE3E"
    },
    "paymentStatus": {
      "cardHolderFullName": "First Last",
      "paymentMethod": "visa",
      "last4": "4242",
      "amountCapturable": 99900,
      "status": "succeeded"
    },
    "amount": 999,
    "currency": "USD"
  },
  "version": 0,
  "cartId": "60b90dd7308ded0008ee3c5d",
  "isValid": false,
  "__v": 0
}

DELETE

api-payment

cart

{cartId}

payment

{paymentId}

Delete payment

curl --request DELETE \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId} \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}"

headers = {"x-site-context": "<x-site-context>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'x-site-context': '<x-site-context>'}};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-site-context", "<x-site-context>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}")
  .header("x-site-context", "<x-site-context>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-payment/cart/{cartId}/payment/{paymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-site-context"] = '<x-site-context>'

response = http.request(request)
puts response.read_body

{
  "billToAddress": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "user1@gmail.com",
    "phone": {
      "number": "3334445555",
      "kind": "Mobile"
    },
    "street1": "1000 main street",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "zipCode": "98101",
    "street2": "1000 main street"
  },
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z",
  "paymentDetails": {
    "transactionDetails": {
      "paymentType": "CARD_STRIPE",
      "paymentToken": "pi_1IyMGc2YBvYaVyBQNkOiCE3E"
    },
    "paymentStatus": {
      "cardHolderFullName": "First Last",
      "paymentMethod": "visa",
      "last4": "4242",
      "amountCapturable": 99900,
      "status": "succeeded"
    },
    "amount": 999,
    "currency": "USD"
  },
  "version": 0,
  "cartId": "60b90dd7308ded0008ee3c5d",
  "isValid": false,
  "__v": 0
}

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

cartId

string

required

Cart ID

Required string length: 24

Example:

"5f8f0da2d4cc8e00084b9e8e"

paymentId

string

required

Payment Id.

Required string length: 24

Example:

"8e9f0da2d4cc8e11184b9e8e"

Response

Delete payment

billToAddress

object

required

Show child attributes

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt

string

Example:

"2020-12-31T02:09:53.914Z"

paymentDetails

object

Show child attributes

version

number

Example:

0

cartId

string

Example:

"60b90dd7308ded0008ee3c5d"

isValid

boolean

Example:

false

__v

number

Example:

0

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Delete payment

Headers

Path Parameters

Response