Update payment

curl --request PATCH \
  --url https://api.fabric.inc/v3/carts/{cartId}/payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "provider": "verifone",
  "processor": "stripe",
  "method": "stripe",
  "methodType": "cc",
  "state": "PENDING",
  "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
  "cardDetails": {},
  "attributes": {
    "gift-card-name": "custom name"
  }
}
'

import requests

url = "https://api.fabric.inc/v3/carts/{cartId}/payments/{id}"

payload = {
    "provider": "verifone",
    "processor": "stripe",
    "method": "stripe",
    "methodType": "cc",
    "state": "PENDING",
    "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
    "cardDetails": {},
    "attributes": { "gift-card-name": "custom name" }
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    provider: 'verifone',
    processor: 'stripe',
    method: 'stripe',
    methodType: 'cc',
    state: 'PENDING',
    billToAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
    cardDetails: {},
    attributes: {'gift-card-name': 'custom name'}
  })
};

fetch('https://api.fabric.inc/v3/carts/{cartId}/payments/{id}', 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://api.fabric.inc/v3/carts/{cartId}/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'provider' => 'verifone',
    'processor' => 'stripe',
    'method' => 'stripe',
    'methodType' => 'cc',
    'state' => 'PENDING',
    'billToAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
    'cardDetails' => [
        
    ],
    'attributes' => [
        'gift-card-name' => 'custom name'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.fabric.inc/v3/carts/{cartId}/payments/{id}"

	payload := strings.NewReader("{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.fabric.inc/v3/carts/{cartId}/payments/{id}")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/carts/{cartId}/payments/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}"

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

{
  "id": "6ef2067a-5d6b-4785-a090-96ea0078220d",
  "provider": "verifone",
  "processor": "stripe",
  "method": "apple pay",
  "methodType": "credit card",
  "state": "PENDING",
  "authorization": {
    "amount": 8,
    "expiry": "2024-06-13T16:50:00.682Z",
    "verifier": {
      "type": "TOKEN",
      "key": "CH39082K439R0"
    }
  },
  "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
  "cardDetails": {},
  "attributes": {
    "gift-card-name": "custom name"
  }
}

{
  "type": "BAD_REQUEST",
  "message": "x-fabric-tenant-id is required"
}

{
  "type": "CART_NOT_FOUND",
  "message": "Cart not found"
}

PATCH

carts

{cartId}

payments

{id}

Update payment

curl --request PATCH \
  --url https://api.fabric.inc/v3/carts/{cartId}/payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "provider": "verifone",
  "processor": "stripe",
  "method": "stripe",
  "methodType": "cc",
  "state": "PENDING",
  "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
  "cardDetails": {},
  "attributes": {
    "gift-card-name": "custom name"
  }
}
'

import requests

url = "https://api.fabric.inc/v3/carts/{cartId}/payments/{id}"

payload = {
    "provider": "verifone",
    "processor": "stripe",
    "method": "stripe",
    "methodType": "cc",
    "state": "PENDING",
    "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
    "cardDetails": {},
    "attributes": { "gift-card-name": "custom name" }
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    provider: 'verifone',
    processor: 'stripe',
    method: 'stripe',
    methodType: 'cc',
    state: 'PENDING',
    billToAddress: 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
    cardDetails: {},
    attributes: {'gift-card-name': 'custom name'}
  })
};

fetch('https://api.fabric.inc/v3/carts/{cartId}/payments/{id}', 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://api.fabric.inc/v3/carts/{cartId}/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'provider' => 'verifone',
    'processor' => 'stripe',
    'method' => 'stripe',
    'methodType' => 'cc',
    'state' => 'PENDING',
    'billToAddress' => 'a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93',
    'cardDetails' => [
        
    ],
    'attributes' => [
        'gift-card-name' => 'custom name'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.fabric.inc/v3/carts/{cartId}/payments/{id}"

	payload := strings.NewReader("{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.fabric.inc/v3/carts/{cartId}/payments/{id}")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/carts/{cartId}/payments/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"verifone\",\n  \"processor\": \"stripe\",\n  \"method\": \"stripe\",\n  \"methodType\": \"cc\",\n  \"state\": \"PENDING\",\n  \"billToAddress\": \"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93\",\n  \"cardDetails\": {},\n  \"attributes\": {\n    \"gift-card-name\": \"custom name\"\n  }\n}"

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

{
  "id": "6ef2067a-5d6b-4785-a090-96ea0078220d",
  "provider": "verifone",
  "processor": "stripe",
  "method": "apple pay",
  "methodType": "credit card",
  "state": "PENDING",
  "authorization": {
    "amount": 8,
    "expiry": "2024-06-13T16:50:00.682Z",
    "verifier": {
      "type": "TOKEN",
      "key": "CH39082K439R0"
    }
  },
  "billToAddress": "a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93",
  "cardDetails": {},
  "attributes": {
    "gift-card-name": "custom name"
  }
}

{
  "type": "BAD_REQUEST",
  "message": "x-fabric-tenant-id is required"
}

{
  "type": "CART_NOT_FOUND",
  "message": "Cart not found"
}

Authorizations

Authorization

string

header

required

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"617329dfd5288b0011332311"

x-fabric-request-id

string

Unique request ID for tracking.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.

Example:

"12"

Path Parameters

cartId

string

required

The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.

string

required

The Payment ID that was generated when a payment was created using the Create payment endpoint.

Body

application/json

Payment Request

provider

string

The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.

Example:

"verifone"

processor

string

The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.

Example:

"stripe"

method

string

Payment method

Example:

"stripe"

methodType

string

Payment method type

Example:

"cc"

state

enum<string>

Payment state

Available options:

PENDING,

AUTHORIZED,

CAPTURED,

FAILED

Example:

"PENDING"

authorization

object

Payment authorization

Show child attributes

billToAddress

string

Identifier of billing address

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

cardDetails

object

Information about the card used for payment, such as gift card details.

Show child attributes

attributes

object

Custom attributes associated with the transaction, such as the name of the gift card used.

Show child attributes

Example:

{ "gift-card-name": "custom name" }

Response

Cart Payment

string

The Payment ID that was generated when a payment was created using the Create payment endpoint.

Example:

"6ef2067a-5d6b-4785-a090-96ea0078220d"

provider

string

The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.

Example:

"verifone"

processor

string

The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.

Example:

"stripe"

method

string

Payment method, such as Apple Pay, used for processing transactions.

Example:

"apple pay"

methodType

string

Payment method type, such as a credit card.

Example:

"credit card"

state

enum<string>

Payment state indicates whether the payment has been successfully processed.

Available options:

PENDING,

AUTHORIZED,

CAPTURED,

FAILED

Example:

"PENDING"

authorization

object

Payment authorization

Show child attributes

billToAddress

string

The Address ID that was generated when an address was created using the Create address endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

cardDetails

object

Information about the card used for payment, such as gift card details.

Show child attributes

attributes

object

Custom attributes associated with the transaction, such as the name of the gift card used.

Show child attributes

Example:

{ "gift-card-name": "custom name" }