CopycURL Copied Copy failed

#!/usr/bin/env bash
# Refund or void a payment
#
# Undo a payment both ways: cancel one before the batch closes, then credit part of another back
# after it has settled, and read which of the two a transaction will actually accept.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

set -euo pipefail

BASE_URL="{{BASE_URL}}"
API_KEY="{{API_KEY}}"

# Sends one request and prints the response body. A failed call prints the API's answer and stops
# the script.
call() {
  local method="$1" path="$2" body="${3:-}" out
  local args=(-sS --fail-with-body -X "$method" "$BASE_URL$path" -H "api-key: $API_KEY")
  if [ -n "$body" ]; then
    args+=(-H "Content-Type: application/json" -d "$body")
  fi
  if ! out=$(curl "${args[@]}"); then
    printf '%s\n' "$out" >&2
    return 1
  fi
  printf '%s' "$out"
}

# Percent-encodes a value for use in a URL.
urlencode() {
  jq -rn --arg value "$1" '$value | @uri'
}

# Phase 1: Set up your sandbox

# Step 1: Get an API key for a sandbox merchant
# Every call below sends an api-key header. Create a key against a sandbox merchant in the
# application and keep it out of source control: the samples on this page leave it as a placeholder
# for exactly that reason. Nothing here reaches a card network, and nothing here is reversible from
# the cardholder's side, which is what makes the sandbox the right place to get the undo path wrong
# the first time.

# Phase 2: Cancel a payment before it settles

# Step 2: Create a sale you are going to cancel
step2=$(call POST "/api/transactions" '{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}')
transactionId=$(jq -er '.id | if . == null then error("The response carried no value for transactionId.") else tostring end' <<< "$step2")
merchantId=$(jq -er '.merchantId | if . == null then error("The response carried no value for merchantId.") else tostring end' <<< "$step2")

# Step 3: Read which undo the transaction allows
call GET "/api/transactions/$(urlencode "$transactionId")" > /dev/null

# Step 4: Cancel it before the batch closes
call POST "/api/transactions/by-merchant/$(urlencode "$merchantId")/$(urlencode "$transactionId")/operations" '{
  "operationType": "Reversal",
  "reason": "Customer cancelled before shipping"
}' > /dev/null

# Phase 3: Refund a payment after it settles

# Step 5: Create a second sale to refund later
step5=$(call POST "/api/transactions" '{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}')
settledTransactionId=$(jq -er '.id | if . == null then error("The response carried no value for settledTransactionId.") else tostring end' <<< "$step5")

# Step 6: Close your sandbox batch
call POST "/api/transactions/settlements/sandbox/close" > /dev/null

# Step 7: Refund part of it once it has settled
step7=$(call POST "/api/transactions/by-merchant/$(urlencode "$merchantId")/$(urlencode "$settledTransactionId")/operations" '{
  "operationType": "Refund",
  "amount": 5.00,
  "reason": "Returned one item"
}')
refundTransactionId=$(jq -er '.newTransactionId | if . == null then error("The response carried no value for refundTransactionId.") else tostring end' <<< "$step7")

# Step 8: Read the credit back
call GET "/api/transactions/$(urlencode "$refundTransactionId")" > /dev/null

CopyPowerShell Copied Copy failed

# Refund or void a payment
#
# Undo a payment both ways: cancel one before the batch closes, then credit part of another back
# after it has settled, and read which of the two a transaction will actually accept.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

$ErrorActionPreference = 'Stop'

$baseUrl = '{{BASE_URL}}'
$apiKey = '{{API_KEY}}'

# Sends one request and returns the parsed response body. A failed call stops the script.
function Invoke-BlueprintCall([string] $Method, [string] $Path, [string] $Body) {
    $arguments = @{
        Method  = $Method
        Uri     = $baseUrl + $Path
        Headers = @{ 'api-key' = $apiKey }
    }
    if ($Body) {
        $arguments.ContentType = 'application/json'
        $arguments.Body = [System.Text.Encoding]::UTF8.GetBytes($Body)
    }
    Invoke-RestMethod @arguments
}

# Turns a value read off a response back into the text the API sent. A missing value stops the
# script.
function ConvertTo-CaptureValue($Value, [string] $Name) {
    if ($null -eq $Value) { throw "The response carried no value for $Name." }
    if ($Value -is [datetime] -and $Value.Kind -eq 'Unspecified') { return $Value.ToString('yyyy-MM-ddTHH:mm:ss.FFFFFFF', [cultureinfo]::InvariantCulture) }
    if ($Value -is [datetime]) { return $Value.ToUniversalTime().ToString('o') }
    if ($Value -is [bool]) { return $Value.ToString().ToLowerInvariant() }
    [string]$Value
}

# Phase 1: Set up your sandbox

# Step 1: Get an API key for a sandbox merchant
# Every call below sends an api-key header. Create a key against a sandbox merchant in the
# application and keep it out of source control: the samples on this page leave it as a placeholder
# for exactly that reason. Nothing here reaches a card network, and nothing here is reversible from
# the cardholder's side, which is what makes the sandbox the right place to get the undo path wrong
# the first time.

# Phase 2: Cancel a payment before it settles

# Step 2: Create a sale you are going to cancel
$body = @'
{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}
'@
$step2 = Invoke-BlueprintCall -Method 'POST' -Path '/api/transactions' -Body $body
$transactionId = ConvertTo-CaptureValue $step2.id 'transactionId'
$merchantId = ConvertTo-CaptureValue $step2.merchantId 'merchantId'

# Step 3: Read which undo the transaction allows
$null = Invoke-BlueprintCall -Method 'GET' -Path "/api/transactions/$([uri]::EscapeDataString($transactionId))"

# Step 4: Cancel it before the batch closes
$body = @'
{
  "operationType": "Reversal",
  "reason": "Customer cancelled before shipping"
}
'@
$null = Invoke-BlueprintCall -Method 'POST' -Path "/api/transactions/by-merchant/$([uri]::EscapeDataString($merchantId))/$([uri]::EscapeDataString($transactionId))/operations" -Body $body

# Phase 3: Refund a payment after it settles

# Step 5: Create a second sale to refund later
$body = @'
{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}
'@
$step5 = Invoke-BlueprintCall -Method 'POST' -Path '/api/transactions' -Body $body
$settledTransactionId = ConvertTo-CaptureValue $step5.id 'settledTransactionId'

# Step 6: Close your sandbox batch
$null = Invoke-BlueprintCall -Method 'POST' -Path '/api/transactions/settlements/sandbox/close'

# Step 7: Refund part of it once it has settled
$body = @'
{
  "operationType": "Refund",
  "amount": 5.00,
  "reason": "Returned one item"
}
'@
$step7 = Invoke-BlueprintCall -Method 'POST' -Path "/api/transactions/by-merchant/$([uri]::EscapeDataString($merchantId))/$([uri]::EscapeDataString($settledTransactionId))/operations" -Body $body
$refundTransactionId = ConvertTo-CaptureValue $step7.newTransactionId 'refundTransactionId'

# Step 8: Read the credit back
$null = Invoke-BlueprintCall -Method 'GET' -Path "/api/transactions/$([uri]::EscapeDataString($refundTransactionId))"

CopyTypeScript Copied Copy failed

// Refund or void a payment
//
// Undo a payment both ways: cancel one before the batch closes, then credit part of another back
// after it has settled, and read which of the two a transaction will actually accept.
//
// Every API call in this blueprint, in order. Each value a call returns is passed to the calls
// after it. A step that happens outside the API is a comment, and any failed call stops the script.

export {};

const baseUrl = '{{BASE_URL}}';
const apiKey = '{{API_KEY}}';

// Sends one request and returns the parsed response body. A failed call throws.
async function call(method: string, path: string, body?: unknown): Promise<any> {
  const headers: Record<string, string> = { 'api-key': apiKey };
  if (body !== undefined) {
    headers['Content-Type'] = 'application/json';
  }

  const response = await fetch(baseUrl + path, {
    method,
    headers,
    body: body === undefined ? undefined : JSON.stringify(body),
  });

  const text = await response.text();
  if (!response.ok) {
    throw new Error(`${method} ${path} answered ${response.status}: ${text}`);
  }

  return text ? JSON.parse(text) : null;
}

// Turns a value read off a response into the text the API sent. A missing value throws.
function capture(value: unknown, name: string): string {
  if (value === undefined || value === null) {
    throw new Error(`The response carried no value for ${name}.`);
  }

  return typeof value === 'string' ? value : JSON.stringify(value);
}

// Phase 1: Set up your sandbox

// Step 1: Get an API key for a sandbox merchant
// Every call below sends an api-key header. Create a key against a sandbox merchant in the
// application and keep it out of source control: the samples on this page leave it as a placeholder
// for exactly that reason. Nothing here reaches a card network, and nothing here is reversible from
// the cardholder's side, which is what makes the sandbox the right place to get the undo path wrong
// the first time.

// Phase 2: Cancel a payment before it settles

// Step 2: Create a sale you are going to cancel
const step2 = await call('POST', '/api/transactions', {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
});
const transactionId = capture(step2.id, 'transactionId');
const merchantId = capture(step2.merchantId, 'merchantId');

// Step 3: Read which undo the transaction allows
await call('GET', `/api/transactions/${encodeURIComponent(transactionId)}`);

// Step 4: Cancel it before the batch closes
await call('POST', `/api/transactions/by-merchant/${encodeURIComponent(merchantId)}/${encodeURIComponent(transactionId)}/operations`, {
  "operationType": "Reversal",
  "reason": "Customer cancelled before shipping"
});

// Phase 3: Refund a payment after it settles

// Step 5: Create a second sale to refund later
const step5 = await call('POST', '/api/transactions', {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
});
const settledTransactionId = capture(step5.id, 'settledTransactionId');

// Step 6: Close your sandbox batch
await call('POST', '/api/transactions/settlements/sandbox/close');

// Step 7: Refund part of it once it has settled
const step7 = await call('POST', `/api/transactions/by-merchant/${encodeURIComponent(merchantId)}/${encodeURIComponent(settledTransactionId)}/operations`, {
  "operationType": "Refund",
  "amount": 5.00,
  "reason": "Returned one item"
});
const refundTransactionId = capture(step7.newTransactionId, 'refundTransactionId');

// Step 8: Read the credit back
await call('GET', `/api/transactions/${encodeURIComponent(refundTransactionId)}`);

CopyC# Copied Copy failed

// Refund or void a payment
//
// Undo a payment both ways: cancel one before the batch closes, then credit part of another back
// after it has settled, and read which of the two a transaction will actually accept.
//
// Every API call in this blueprint, in order. Each value a call returns is passed to the calls
// after it. A step that happens outside the API is a comment, and any failed call stops the script.

using System.Text;
using System.Text.Json;

var baseUrl = "{{BASE_URL}}";
var apiKey = "{{API_KEY}}";

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("api-key", apiKey);

// Sends one request and returns the parsed response body. A failed call throws.
async Task<JsonElement> CallAsync(string method, string path, string? body = null)
{
    using var request = new HttpRequestMessage(new HttpMethod(method), baseUrl + path);
    if (body is not null)
    {
        request.Content = new StringContent(body, Encoding.UTF8, "application/json");
    }

    using var response = await http.SendAsync(request);
    var json = await response.Content.ReadAsStringAsync();
    if (!response.IsSuccessStatusCode)
    {
        throw new HttpRequestException($"{method} {path} answered {(int)response.StatusCode}: {json}");
    }

    return json.Length == 0 ? default : JsonSerializer.Deserialize<JsonElement>(json);
}

// Turns a value read off a response into the text the API sent. A missing value throws.
static string Capture(JsonElement value, string name) => value.ValueKind switch
{
    JsonValueKind.String => value.GetString()!,
    JsonValueKind.Number or JsonValueKind.True or JsonValueKind.False => value.GetRawText(),
    _ => throw new InvalidOperationException($"The response carried no value for {name}.")
};

// Phase 1: Set up your sandbox

// Step 1: Get an API key for a sandbox merchant
// Every call below sends an api-key header. Create a key against a sandbox merchant in the
// application and keep it out of source control: the samples on this page leave it as a placeholder
// for exactly that reason. Nothing here reaches a card network, and nothing here is reversible from
// the cardholder's side, which is what makes the sandbox the right place to get the undo path wrong
// the first time.

// Phase 2: Cancel a payment before it settles

// Step 2: Create a sale you are going to cancel
var step2 = await CallAsync("POST", "/api/transactions", """
    {
      "transactionType": "Sale",
      "cardData": {
        "cardNumber": "4111111111111111",
        "nameOnCard": "Jane Doe",
        "expirationMonth": 12,
        "expirationYear": 2030,
        "cvv": 123
      },
      "invoiceData": {
        "amounts": { "base": 10.00, "total": 10.00 }
      }
    }
    """);
var transactionId = Capture(step2.GetProperty("id"), "transactionId");
var merchantId = Capture(step2.GetProperty("merchantId"), "merchantId");

// Step 3: Read which undo the transaction allows
await CallAsync("GET", $"/api/transactions/{Uri.EscapeDataString(transactionId)}");

// Step 4: Cancel it before the batch closes
await CallAsync("POST", $"/api/transactions/by-merchant/{Uri.EscapeDataString(merchantId)}/{Uri.EscapeDataString(transactionId)}/operations", """
    {
      "operationType": "Reversal",
      "reason": "Customer cancelled before shipping"
    }
    """);

// Phase 3: Refund a payment after it settles

// Step 5: Create a second sale to refund later
var step5 = await CallAsync("POST", "/api/transactions", """
    {
      "transactionType": "Sale",
      "cardData": {
        "cardNumber": "4111111111111111",
        "nameOnCard": "Jane Doe",
        "expirationMonth": 12,
        "expirationYear": 2030,
        "cvv": 123
      },
      "invoiceData": {
        "amounts": { "base": 10.00, "total": 10.00 }
      }
    }
    """);
var settledTransactionId = Capture(step5.GetProperty("id"), "settledTransactionId");

// Step 6: Close your sandbox batch
await CallAsync("POST", "/api/transactions/settlements/sandbox/close");

// Step 7: Refund part of it once it has settled
var step7 = await CallAsync("POST", $"/api/transactions/by-merchant/{Uri.EscapeDataString(merchantId)}/{Uri.EscapeDataString(settledTransactionId)}/operations", """
    {
      "operationType": "Refund",
      "amount": 5.00,
      "reason": "Returned one item"
    }
    """);
var refundTransactionId = Capture(step7.GetProperty("newTransactionId"), "refundTransactionId");

// Step 8: Read the credit back
await CallAsync("GET", $"/api/transactions/{Uri.EscapeDataString(refundTransactionId)}");

CopyPython Copied Copy failed

# Refund or void a payment
#
# Undo a payment both ways: cancel one before the batch closes, then credit part of another back
# after it has settled, and read which of the two a transaction will actually accept.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

from urllib.parse import quote

import json
import requests

BASE_URL = "{{BASE_URL}}"
API_KEY = "{{API_KEY}}"


# Sends one request and returns the parsed response body. A failed call raises.
def call(method, path, body=None):
    response = requests.request(
        method,
        BASE_URL + path,
        headers={"api-key": API_KEY},
        json=body,
    )
    response.raise_for_status()
    return response.json() if response.content else None


# Turns a value read off a response into the text the API sent. A missing value raises.
def capture(value, name):
    if value is None:
        raise ValueError(f"The response carried no value for {name}.")
    return value if isinstance(value, str) else json.dumps(value)


# Phase 1: Set up your sandbox

# Step 1: Get an API key for a sandbox merchant
# Every call below sends an api-key header. Create a key against a sandbox merchant in the
# application and keep it out of source control: the samples on this page leave it as a placeholder
# for exactly that reason. Nothing here reaches a card network, and nothing here is reversible from
# the cardholder's side, which is what makes the sandbox the right place to get the undo path wrong
# the first time.

# Phase 2: Cancel a payment before it settles

# Step 2: Create a sale you are going to cancel
step2 = call("POST", "/api/transactions", {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
})
transaction_id = capture(step2["id"], "transactionId")
merchant_id = capture(step2["merchantId"], "merchantId")

# Step 3: Read which undo the transaction allows
call("GET", f"/api/transactions/{quote(transaction_id, safe='')}")

# Step 4: Cancel it before the batch closes
call("POST", f"/api/transactions/by-merchant/{quote(merchant_id, safe='')}/{quote(transaction_id, safe='')}/operations", {
  "operationType": "Reversal",
  "reason": "Customer cancelled before shipping"
})

# Phase 3: Refund a payment after it settles

# Step 5: Create a second sale to refund later
step5 = call("POST", "/api/transactions", {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
})
settled_transaction_id = capture(step5["id"], "settledTransactionId")

# Step 6: Close your sandbox batch
call("POST", "/api/transactions/settlements/sandbox/close")

# Step 7: Refund part of it once it has settled
step7 = call("POST", f"/api/transactions/by-merchant/{quote(merchant_id, safe='')}/{quote(settled_transaction_id, safe='')}/operations", {
  "operationType": "Refund",
  "amount": 5.00,
  "reason": "Returned one item"
})
refund_transaction_id = capture(step7["newTransactionId"], "refundTransactionId")

# Step 8: Read the credit back
call("GET", f"/api/transactions/{quote(refund_transaction_id, safe='')}")