Skip to main content

Documentation

Capture Payment

Capture some or all of a card payment that was previously authorized with capture set to false.

This method changes the payment object status to CLO and triggers Payment Captured Webhook. This webhook contains the same information as the response. This method also triggers Payment Completed Webhook. The capture operation is also known as clearing or completion.

The scope of the capture operation depends on the client's pre-authorization permissions. To change these permissions, contact Rapyd Client Support.

Without pre-authorization permissions:

  • The amount captured must be equal to the amount authorized.

  • If the payment is not captured in 7 days, it expires. The expiration can be configured for a shorter time.

With pre-authorization permissions:

  • The amount captured can be less than or equal to the amount authorized.

  • If the payment is not captured in 30 days, it expires. The expiration can be configured for a shorter time.

Parameters
Request Path Parameters

    • payment

    • ID of the payment. String starting with payment_.

Request Header Parameters
Request Body Parameters

    • amount

    • The amount to capture, in units of the currency defined in currency. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015.

    • receipt_email

    • Email address that the receipt for this transaction is sent to.

    • statement_descriptor

    • A text description suitable for a customer's payment statement. Some payment methods truncate this string to a limited number of characters.

Response Parameters
Code Samples

    • .NET

      • using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {

                string result = RapydApiRequestSample.Utilities.MakeRequest("POST", $"/v1/payments/payment_19e3edad1e9102cd24006a34c52c9a0b/capture");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest(
      'POST',
      '/v1/payments/payment_19e3edad1e9102cd24006a34c52c9a0b/capture'
    );

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

    • PHP

      • <?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('post', '/v1/payments/payment_19e3edad1e9102cd24006a34c52c9a0b/capture');
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

    • Python

      • from pprint import pprint

from utilities import make_request

response = make_request(method='post',
                        path=f'/v1/payments/payment_19e3edad1e9102cd24006a34c52c9a0b/capture'
pprint(response)

  • /v1/payments/:payment/capture

  • Capture Payment - Full

  • curl -X post
https://sandboxapi.rapyd.net/v1/payments/payment_b1ce11f456da5626e5660eced36fd289/capture
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

  • {
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "2617a19d-02d6-449e-a96c-1ae8c8ef3e7c"
    },
    "data": {
        "id": "payment_b1ce11f456da5626e5660eced36fd289",
        "amount": 279,
        "original_amount": 279,
        "is_partial": false,
        "currency_code": "USD",
        "country_code": "US",
        "status": "CLO",
        "description": "",
        "merchant_reference_id": "",
        "customer_token": "cus_d4de841cc62e730d0b89b03c2aecf26e",
        "payment_method": "card_d93bffea8bc5c1d473212cc38eec3af6",
        "payment_method_data": {
            "id": "card_d93bffea8bc5c1d473212cc38eec3af6",
            "type": "us_mastercard_card",
            "category": "card",
            "metadata": null,
            "image": "",
            "authentication_url": "",
            "webhook_url": "",
            "supporting_documentation": "",
            "name": "John Doe",
            "last4": "0414",
            "acs_check": "unchecked",
            "cvv_check": "unchecked",
            "bin_details": {
                "brand": null,
                "bin_number": "554672"
            },
            "expiration_year": "23",
            "expiration_month": "11",
            "fingerprint_token": "ocfp_5f5a0376b98d8238064a232cc51f6f4e"
        },
        "expiration": 1622468294,
        "captured": true,
        "refunded": false,
        "refunded_amount": 0,
        "receipt_email": "",
        "redirect_url": "",
        "complete_payment_url": "",
        "error_payment_url": "",
        "receipt_number": "",
        "flow_type": "",
        "address": null,
        "statement_descriptor": "Rapyd",
        "transaction_id": "",
        "created_at": 1621863494,
        "metadata": {
            "merchant_defined": true
        },
        "failure_code": "",
        "failure_message": "",
        "paid": true,
        "paid_at": 1621945084,
        "dispute": null,
        "refunds": null,
        "order": null,
        "outcome": null,
        "visual_codes": {},
        "textual_codes": {},
        "instructions": [],
        "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
        "ewallets": [
            {
                "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 279,
                "percent": 100,
                "refunded_amount": 0
            }
        ],
        "payment_method_options": {},
        "payment_method_type": "us_mastercard_card",
        "payment_method_type_category": "card",
        "fx_rate": 1,
        "merchant_requested_currency": null,
        "merchant_requested_amount": null,
        "fixed_side": "",
        "payment_fees": null,
        "invoice": "",
        "escrow": null,
        "group_payment": "",
        "cancel_reason": null,
        "initiation_type": "customer_present",
        "mid": "",
        "next_action": "not_applicable"
    }
}

  • Capture Payment - Partial

  • curl -X post
https://sandboxapi.rapyd.net/v1/payments/payment_6cc10a51cbc9e84e49e3bc55350bbb8c/capture
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '
{
    "amount": 12
}'

  • {
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "1f2bcd8b-a6ea-4cf5-9d88-2e7afba09b10"
    },
    "data": {
        "id": "payment_6cc10a51cbc9e84e49e3bc55350bbb8c",
        "amount": 12,
        "original_amount": 279,
        "is_partial": true,
        "currency_code": "USD",
        "country_code": "US",
        "status": "CLO",
        "description": "",
        "merchant_reference_id": "",
        "customer_token": "cus_482125ea7824229596380a2d3b50a7cd",
        "payment_method": "card_7aa04cdf8e165917c082779aff029785",
        "payment_method_data": {
            "id": "card_7aa04cdf8e165917c082779aff029785",
            "type": "us_mastercard_card",
            "category": "card",
            "metadata": null,
            "image": "",
            "authentication_url": "",
            "webhook_url": "",
            "supporting_documentation": "",
            "name": "John Doe",
            "last4": "0414",
            "acs_check": "unchecked",
            "cvv_check": "unchecked",
            "bin_details": {
                "brand": null,
                "bin_number": "554672"
            },
            "expiration_year": "23",
            "expiration_month": "11",
            "fingerprint_token": "ocfp_5f5a0376b98d8238064a232cc51f6f4e"
        },
        "expiration": 1622549964,
        "captured": true,
        "refunded": false,
        "refunded_amount": 0,
        "receipt_email": "",
        "redirect_url": "",
        "complete_payment_url": "",
        "error_payment_url": "",
        "receipt_number": "",
        "flow_type": "",
        "address": null,
        "statement_descriptor": "Rapyd",
        "transaction_id": "",
        "created_at": 1621945164,
        "metadata": {
            "merchant_defined": true
        },
        "failure_code": "",
        "failure_message": "",
        "paid": true,
        "paid_at": 1621945205,
        "dispute": null,
        "refunds": null,
        "order": null,
        "outcome": null,
        "visual_codes": {},
        "textual_codes": {},
        "instructions": [],
        "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
        "ewallets": [
            {
                "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 279,
                "percent": 100,
                "refunded_amount": 0
            }
        ],
        "payment_method_options": {},
        "payment_method_type": "us_mastercard_card",
        "payment_method_type_category": "card",
        "fx_rate": 1,
        "merchant_requested_currency": null,
        "merchant_requested_amount": null,
        "fixed_side": "",
        "payment_fees": null,
        "invoice": "",
        "escrow": null,
        "group_payment": "",
        "cancel_reason": null,
        "initiation_type": "customer_present",
        "mid": "",
        "next_action": "not_applicable"
    }
}
In this section:

The second phase in completing a card transaction, also known as capture or completion.

The second phase in completing a card transaction, also known as capture or clearing.

The first phase of processing a card transaction, also known as authorization. The funds are placed on hold until the transaction is captured or cleared. The authorization confirms whether a card is valid, business rules and regulations are met, or the required funds exist.

The number of seconds elapsed since the beginning of the Unix epoch, which was 00:00:00 GMT on January 1, 1970. 10-digit integer.

A number for a bank account that is used for international transfers.

A server used by issuing banks to authenticate card users by 3DS authentication.

For card transactions, a service that checks whether the cardholder's billing address matches the address for the cardholder's account.

An alphanumeric identifier for financial institutions, also known informally as a SWIFT code or SWIFT/BIC code.

A numeric identifier for financial institutions. It appears as the first four to six digits on a payment card.

A unique number for a payment card, usually 14 to 19 digits in length. Also known as a card number, payment card number or funding primary account number (FPAN).

A numeric code printed on the card, consisting of 3 or 4 digits. Use of the code indicates that the person making the transaction has access to the physical card. This value cannot be stored in any way. Also known as CCV, CID, CSC and CVC.

A protocol that provides increased security for card-not-present transactions. Rapyd supports version 2.2.