Perform a payment gateway capture operation
curl --request PUT \
--url https://api.orchestrasolutions.com/PaymentGateway/capture \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"refTransId": "<string>",
"amount": 123,
"card": {
"cardHolderName": "<string>",
"cardNumber": "<string>",
"expirationYear": 123,
"expirationMonth": 123,
"ownerID": "<string>",
"issueNumber": "<string>",
"cvv": "<string>"
},
"myRef": "<string>",
"paymentGatewayAccountName": "<string>",
"certificateName": "<string>",
"paymentGatewayAccount": {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.orchestrasolutions.com/PaymentGateway/capture"
payload = {
"currency": "<string>",
"refTransId": "<string>",
"amount": 123,
"card": {
"cardHolderName": "<string>",
"cardNumber": "<string>",
"expirationYear": 123,
"expirationMonth": 123,
"ownerID": "<string>",
"issueNumber": "<string>",
"cvv": "<string>"
},
"myRef": "<string>",
"paymentGatewayAccountName": "<string>",
"certificateName": "<string>",
"paymentGatewayAccount": {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
refTransId: '<string>',
amount: 123,
card: {
cardHolderName: '<string>',
cardNumber: '<string>',
expirationYear: 123,
expirationMonth: 123,
ownerID: '<string>',
issueNumber: '<string>',
cvv: '<string>'
},
myRef: '<string>',
paymentGatewayAccountName: '<string>',
certificateName: '<string>',
paymentGatewayAccount: {
paymentGatewayName: '<string>',
credentials: [{key: '<string>', value: '<string>'}]
}
})
};
fetch('https://api.orchestrasolutions.com/PaymentGateway/capture', 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.orchestrasolutions.com/PaymentGateway/capture",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'refTransId' => '<string>',
'amount' => 123,
'card' => [
'cardHolderName' => '<string>',
'cardNumber' => '<string>',
'expirationYear' => 123,
'expirationMonth' => 123,
'ownerID' => '<string>',
'issueNumber' => '<string>',
'cvv' => '<string>'
],
'myRef' => '<string>',
'paymentGatewayAccountName' => '<string>',
'certificateName' => '<string>',
'paymentGatewayAccount' => [
'paymentGatewayName' => '<string>',
'credentials' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.orchestrasolutions.com/PaymentGateway/capture"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.orchestrasolutions.com/PaymentGateway/capture")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orchestrasolutions.com/PaymentGateway/capture")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"authorizationCode": "<string>",
"currency": "AFN",
"amount": 123,
"operationType": "Charge",
"operationResultCode": "Success",
"operationResultDescription": "<string>",
"customGatewayResponse": null,
"gatewayName": "<string>",
"gatewayReference": "<string>",
"gatewayResultCode": "<string>",
"gatewayResultDescription": "<string>",
"gatewayResultSubCode": "<string>",
"gatewayResultSubDescription": "<string>",
"gatewayToken": null,
"rejectReasonCode": "None"
}[
{
"fieldName": "<string>",
"errors": [
"<string>"
]
}
]Payment Operations
Perform a payment gateway capture operation
This method allows you to perform a “capture” operation on a previously created “authorize” operation (see our [POST] /PaymentGateway/authorize method for additional information).
When you perform the “authorize” operation, the bank that issued the credit card will place an authorization of the total amount of the funds. This is how the bank determines if the funds are available to make the purchase. The card will not actually be “charged” until you perform the “capture” operation.
Please note, different card brands and different banks allow for different time frames on the lifespan of a payment authorization. You will need to check with your payment processor on how long you would have between performing an “authorize” operation and a “charge” operation”.
PUT
/
PaymentGateway
/
capture
Perform a payment gateway capture operation
curl --request PUT \
--url https://api.orchestrasolutions.com/PaymentGateway/capture \
--header 'Content-Type: application/json' \
--data '
{
"currency": "<string>",
"refTransId": "<string>",
"amount": 123,
"card": {
"cardHolderName": "<string>",
"cardNumber": "<string>",
"expirationYear": 123,
"expirationMonth": 123,
"ownerID": "<string>",
"issueNumber": "<string>",
"cvv": "<string>"
},
"myRef": "<string>",
"paymentGatewayAccountName": "<string>",
"certificateName": "<string>",
"paymentGatewayAccount": {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}
'import requests
url = "https://api.orchestrasolutions.com/PaymentGateway/capture"
payload = {
"currency": "<string>",
"refTransId": "<string>",
"amount": 123,
"card": {
"cardHolderName": "<string>",
"cardNumber": "<string>",
"expirationYear": 123,
"expirationMonth": 123,
"ownerID": "<string>",
"issueNumber": "<string>",
"cvv": "<string>"
},
"myRef": "<string>",
"paymentGatewayAccountName": "<string>",
"certificateName": "<string>",
"paymentGatewayAccount": {
"paymentGatewayName": "<string>",
"credentials": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
currency: '<string>',
refTransId: '<string>',
amount: 123,
card: {
cardHolderName: '<string>',
cardNumber: '<string>',
expirationYear: 123,
expirationMonth: 123,
ownerID: '<string>',
issueNumber: '<string>',
cvv: '<string>'
},
myRef: '<string>',
paymentGatewayAccountName: '<string>',
certificateName: '<string>',
paymentGatewayAccount: {
paymentGatewayName: '<string>',
credentials: [{key: '<string>', value: '<string>'}]
}
})
};
fetch('https://api.orchestrasolutions.com/PaymentGateway/capture', 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.orchestrasolutions.com/PaymentGateway/capture",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'currency' => '<string>',
'refTransId' => '<string>',
'amount' => 123,
'card' => [
'cardHolderName' => '<string>',
'cardNumber' => '<string>',
'expirationYear' => 123,
'expirationMonth' => 123,
'ownerID' => '<string>',
'issueNumber' => '<string>',
'cvv' => '<string>'
],
'myRef' => '<string>',
'paymentGatewayAccountName' => '<string>',
'certificateName' => '<string>',
'paymentGatewayAccount' => [
'paymentGatewayName' => '<string>',
'credentials' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.orchestrasolutions.com/PaymentGateway/capture"
payload := strings.NewReader("{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.orchestrasolutions.com/PaymentGateway/capture")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orchestrasolutions.com/PaymentGateway/capture")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"<string>\",\n \"refTransId\": \"<string>\",\n \"amount\": 123,\n \"card\": {\n \"cardHolderName\": \"<string>\",\n \"cardNumber\": \"<string>\",\n \"expirationYear\": 123,\n \"expirationMonth\": 123,\n \"ownerID\": \"<string>\",\n \"issueNumber\": \"<string>\",\n \"cvv\": \"<string>\"\n },\n \"myRef\": \"<string>\",\n \"paymentGatewayAccountName\": \"<string>\",\n \"certificateName\": \"<string>\",\n \"paymentGatewayAccount\": {\n \"paymentGatewayName\": \"<string>\",\n \"credentials\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"authorizationCode": "<string>",
"currency": "AFN",
"amount": 123,
"operationType": "Charge",
"operationResultCode": "Success",
"operationResultDescription": "<string>",
"customGatewayResponse": null,
"gatewayName": "<string>",
"gatewayReference": "<string>",
"gatewayResultCode": "<string>",
"gatewayResultDescription": "<string>",
"gatewayResultSubCode": "<string>",
"gatewayResultSubDescription": "<string>",
"gatewayToken": null,
"rejectReasonCode": "None"
}[
{
"fieldName": "<string>",
"errors": [
"<string>"
]
}
]Additional parameters may be requiredSome payment processors require custom parameters and properties to be added to the request. See Gateway-Specific Requirements for processors that require additional information.
Payment gateway merchant account credentialsOrchestra offers two options for providing merchant account credentials:
- Inline credentials: Provide the merchant account credentials in the request using the
paymentGatewayAccountobject. - Stored credentials: Use our Payment Gateway Accounts system to pre-upload and store credentials, then reference them with the
paymentGatewayAccountNameparameter.
Authorize & Capture Guide
Complete guide with authorization, capture, and void flows
Body
application/json
Capture Request Model
Model for a Capturing or voiding a previously Pre-authorize request via a payment gateway
The transaction ID that this operation is referring to.
Minimum string length:
1The amount to be charged (the amount should be in major units - for example, 10.23)
The card details that should be charged. You can either provide us with the raw card details or provide a reference to the stored card details in a token.
Show child attributes
Show child attributes
Your custom reference for this transaction
The reference name provided to the stored Payment Gateway Account as set in PUT /PaymentGatewayAccounts/{name}.
Please note, if you provide us with both this parameter and the raw credentials in the paymentGatewayAccount object, this parameter will be ignored and the raw credentials will take precedence.
Optional parameter if the payment gateway requires authentication using a client certificate. The name of the certificate that was stored in our system via our users portal
Maximum string length:
128The raw credentials necessary to connect to the chosen payment gateway as defined in GET /PaymentGateway.
Please note, if you provide us with both the raw details here and a stored Payment Gateway Account in the paymentGatewayAccountName parameter, these credentials will take precedence.
Show child attributes
Show child attributes
Available options:
Visa, MasterCard, Amex Response
OK
Available options:
AFN, EUR, ALL, DZD, USD, AOA, XCD, ARS, AMD, AWG, AUD, AZN, BSD, BHD, BDT, BBD, BYR, BZD, XOF, BMD, BTN, INR, BOB, BOV, BAM, BWP, NOK, BRL, BND, BGN, BIF, KHR, XAF, CAD, CVE, KYD, CLF, CLP, CNY, COP, COU, KMF, CDF, NZD, CRC, HRK, CUC, CUP, ANG, CZK, DKK, DJF, DOP, EGP, SVC, ERN, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GBP, GNF, GYD, HTG, HNL, HKD, HUF, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JPY, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, CHF, LTL, MOP, MKD, MGA, MWK, MYR, MVR, MRO, MUR, XUA, MXN, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, PHP, PLN, QAR, RON, RUB, RWF, SHP, WST, STD, SAR, RSD, SCR, SLL, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, SZL, SEK, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYI, UYU, UZS, VUV, VEF, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG Available options:
Charge, PreAuth, Capture, Void, Refund, Tokenize, Status Available options:
Success, Accepted, Rejected, TemporaryFailure, FatalFailure, NotImplemented Available options:
None, InsufficientFunds, CardExpired, InvalidCard, DoNotHonor, Fraud, LostOrStolenCard, ExceedsLimit, InvalidTransaction, ProcessorDecline, AuthenticationFailed, TechnicalError, Other