Hold Funds

curl -X POST https://api-harmony.compago.com/api/payment-method/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/payment \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 3500,
    "currency": "MXN",
    "description": "Depósito en garantía - Renta de equipo #R-4821",
    "holdFunds": true
  }'

const paymentMethodId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';

const response = await fetch(
  `https://api-harmony.compago.com/api/payment-method/${paymentMethodId}/payment`,
  {
    method: 'POST',
    headers: {
      'x-api-key': process.env.COMPAGO_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      amount: 3500,
      currency: 'MXN',
      description: 'Depósito en garantía - Renta de equipo #R-4821',
      holdFunds: true
    })
  }
);

const hold = await response.json();
console.log('Payment ID:', hold.id);
console.log('Status:', hold.status);
console.log('Expires at:', hold.holdExpiresAt);

import requests
import os

payment_method_id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'

response = requests.post(
    f'https://api-harmony.compago.com/api/payment-method/{payment_method_id}/payment',
    headers={
        'x-api-key': os.environ['COMPAGO_API_KEY'],
        'Content-Type': 'application/json'
    },
    json={
        'amount': 3500,
        'currency': 'MXN',
        'description': 'Depósito en garantía - Renta de equipo #R-4821',
        'holdFunds': True
    }
)

hold = response.json()
print('Payment ID:', hold['id'])
print('Status:', hold['status'])
print('Expires at:', hold['holdExpiresAt'])

<?php
$paymentMethodId = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';

$ch = curl_init("https://api-harmony.compago.com/api/payment-method/{$paymentMethodId}/payment");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-api-key: ' . getenv('COMPAGO_API_KEY'),
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'amount' => 3500,
    'currency' => 'MXN',
    'description' => 'Depósito en garantía - Renta de equipo #R-4821',
    'holdFunds' => true
]));

$response = curl_exec($ch);
$hold = json_decode($response, true);
curl_close($ch);

echo 'Payment ID: ' . $hold['id'] . PHP_EOL;
echo 'Status: ' . $hold['status'] . PHP_EOL;
echo 'Expires at: ' . $hold['holdExpiresAt'] . PHP_EOL;
?>

require 'net/http'
require 'json'
require 'uri'

payment_method_id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
uri = URI("https://api-harmony.compago.com/api/payment-method/#{payment_method_id}/payment")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['x-api-key'] = ENV['COMPAGO_API_KEY']
request['Content-Type'] = 'application/json'
request.body = {
  amount: 3500,
  currency: 'MXN',
  description: 'Depósito en garantía - Renta de equipo #R-4821',
  holdFunds: true
}.to_json

response = http.request(request)
hold = JSON.parse(response.body)

puts "Payment ID: #{hold['id']}"
puts "Status: #{hold['status']}"
puts "Expires at: #{hold['holdExpiresAt']}"

# Capture in full: no request body.
curl -X POST https://api-harmony.compago.com/api/payment-method/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/payment/11111111-2222-3333-4444-555555555555/capture \
  -H "x-api-key: YOUR_API_KEY"

# Capture part of it: 200 of the 1200 that were held.
curl -X POST https://api-harmony.compago.com/api/payment-method/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/payment/11111111-2222-3333-4444-555555555555/capture \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 200 }'

// Leave `amount` undefined to capture the full held amount.
async function captureHold(paymentMethodId, paymentId, amount) {
  const isPartial = amount !== undefined;

  const response = await fetch(
    `https://api-harmony.compago.com/api/payment-method/${paymentMethodId}/payment/${paymentId}/capture`,
    {
      method: 'POST',
      headers: {
        'x-api-key': process.env.COMPAGO_API_KEY,
        ...(isPartial ? { 'Content-Type': 'application/json' } : {})
      },
      ...(isPartial ? { body: JSON.stringify({ amount }) } : {})
    }
  );

  if (response.status === 400) {
    console.error('The amount was not a positive number, or it was more than the held amount.');
  } else if (response.status === 409) {
    console.error('Not capturable: the window closed at 23:00, the hold has no fee channel, or the hold was already captured, released, or expired.');
  } else if (response.status === 402) {
    console.error('The bank declined the capture. The funds may already be gone from the card.');
  }

  const payment = await response.json();
  console.log('Captured', payment.amount, 'of', payment.heldAmount, 'at', payment.capturedAt);
  return payment;
}

await captureHold(paymentMethodId, paymentId);       // the full held amount
await captureHold(paymentMethodId, paymentId, 200);  // only 200 of it

def capture_hold(payment_method_id, payment_id, amount=None):
    response = requests.post(
        f'https://api-harmony.compago.com/api/payment-method/{payment_method_id}/payment/{payment_id}/capture',
        headers={'x-api-key': os.environ['COMPAGO_API_KEY']},
        # No body at all captures the full held amount.
        json=None if amount is None else {'amount': amount}
    )

    if response.status_code == 400:
        print('The amount was not a positive number, or it was more than the held amount.')
    elif response.status_code == 409:
        print('Not capturable: the window closed at 23:00, the hold has no fee channel, or the hold was already captured, released, or expired.')
    elif response.status_code == 402:
        print('The bank declined the capture. The funds may already be gone from the card.')
    else:
        payment = response.json()
        print('Captured', payment['amount'], 'of', payment['heldAmount'], 'at', payment['capturedAt'])

capture_hold(payment_method_id, payment_id)       # the full held amount
capture_hold(payment_method_id, payment_id, 200)  # only 200 of it

<?php
function captureHold($paymentMethodId, $paymentId, $amount = null) {
    $ch = curl_init("https://api-harmony.compago.com/api/payment-method/{$paymentMethodId}/payment/{$paymentId}/capture");
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);

    $headers = ['x-api-key: ' . getenv('COMPAGO_API_KEY')];

    // Send a body only for a partial capture. No body means the full held amount.
    if ($amount !== null) {
        $headers[] = 'Content-Type: application/json';
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['amount' => $amount]));
    }

    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

    $response = curl_exec($ch);
    $payment = json_decode($response, true);
    curl_close($ch);

    echo 'Captured ' . $payment['amount'] . ' of ' . $payment['heldAmount'] . PHP_EOL;

    return $payment;
}

captureHold($paymentMethodId, $paymentId);       // the full held amount
captureHold($paymentMethodId, $paymentId, 200);  // only 200 of it
?>

# Pass no amount to capture the full held amount.
def capture_hold(payment_method_id, payment_id, amount = nil)
  uri = URI("https://api-harmony.compago.com/api/payment-method/#{payment_method_id}/payment/#{payment_id}/capture")

  request = Net::HTTP::Post.new(uri)
  request['x-api-key'] = ENV['COMPAGO_API_KEY']

  # Send a body only for a partial capture.
  unless amount.nil?
    request['Content-Type'] = 'application/json'
    request.body = { amount: amount }.to_json
  end

  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
  payment = JSON.parse(response.body)

  puts "Captured #{payment['amount']} of #{payment['heldAmount']}"

  payment
end

capture_hold(payment_method_id, payment_id)       # the full held amount
capture_hold(payment_method_id, payment_id, 200)  # only 200 of it

curl -X POST https://api-harmony.compago.com/api/payment-method/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/payment/11111111-2222-3333-4444-555555555555/release \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  `https://api-harmony.compago.com/api/payment-method/${paymentMethodId}/payment/${paymentId}/release`,
  {
    method: 'POST',
    headers: { 'x-api-key': process.env.COMPAGO_API_KEY }
  }
);

const payment = await response.json();
console.log('Status:', payment.status, 'Released at:', payment.holdReleasedAt);

response = requests.post(
    f'https://api-harmony.compago.com/api/payment-method/{payment_method_id}/payment/{payment_id}/release',
    headers={'x-api-key': os.environ['COMPAGO_API_KEY']}
)

payment = response.json()
print('Status:', payment['status'], 'Released at:', payment['holdReleasedAt'])