Authorization

An instance of a credit/debit card authorization, with a payment expected to be captured later.

Authorization / Create

Create | Delete | List | Find

Examples

Create Authorization
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

Authorization authorization = Authorization.create(new PaymentsMap()
        .set("amount", 2500)
        .set("card.cvc", "123")
        .set("card.expMonth", 11)
        .set("card.expYear", 35)
        .set("card.number", "5555555555554444")
        .set("currency", "USD")
        .set("description", "test authorization")
        .set("reference", "KP-76TBONES")
);

System.out.println(authorization);

require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

authorization = Simplify::Authorization.create({
        "reference" => "KP-76TBONES",
        "amount" => "2500",
        "description" => "test authorization",
        "currency" => "USD",
        "card" => {
           "number" => "5555555555554444",
           "expMonth" => "11",
           "cvc" => "123",
           "expYear" => "35"
        }
})

puts authorization.inspect

import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

authorization = simplify.Authorization.create({
        "reference" : "KP-76TBONES",
        "amount" : "2500",
        "description" : "test authorization",
        "currency" : "USD",
        "card" : {
           "number" : "5555555555554444",
           "expMonth" : "11",
           "cvc" : "123",
           "expYear" : "35"
        }

})

print(authorization)

<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$authorization = Simplify_Authorization::createAuthorization(array(
        'reference' => 'KP-76TBONES',
        'amount' => '2500',
        'description' => 'test authorization',
        'currency' => 'USD',
        'card' => array(
           'number' => '5555555555554444',
           'expMonth' => '11',
           'cvc' => '123',
           'expYear' => '35'
        )
));

print_r($authorization);

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

my $authorization = Net::Simplify::Authorization->create({
    reference => "KP-76TBONES",
    amount => "2500",
    description => "test authorization",
    currency => "USD",
    card => {
       number => "5555555555554444",
       expMonth => "11",
       cvc => "123",
       expYear => "35"
    }
});

print "Authorization ID ", $authorization->{id}, "\n";

using SimplifyCommerce.Payments;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();

Authorization authorization = new Authorization();
authorization.Amount = 2500;
Card card = new Card();
card.Cvc = "123";
card.ExpMonth = 11;
card.ExpYear = 35;
card.Number = "5555555555554444";
authorization.Card = card;
authorization.Currency = "USD";
authorization.Description = "test authorization";
authorization.Reference = "KP-76TBONES";

try
{
    authorization = (Authorization)api.Create(authorization);
}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}

var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.authorization.create({
    reference : "KP-76TBONES",
    amount : "2500",
    description : "test authorization",
    currency : "USD",
    card : {
       number : "5555555555554444",
       expMonth : "11",
       cvc : "123",
       expYear : "35"
    }
}, function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Success Response: " + JSON.stringify(data));
});
Create Authorization
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

Authorization authorization = Authorization.create(new PaymentsMap()
        .set("amount", 1000)
        .set("currency", "USD")
        .set("description", "payment description")
        .set("reference", "7a6ef6be31")
        .set("token", "[TOKEN ID]")
);

System.out.println(authorization);

require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

authorization = Simplify::Authorization.create({
        "reference" => "7a6ef6be31",
        "amount" => "1000",
        "description" => "payment description",
        "currency" => "USD",
        "token" => "[TOKEN ID]"
})

puts authorization.inspect

import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

authorization = simplify.Authorization.create({
        "reference" : "7a6ef6be31",
        "amount" : "1000",
        "description" : "payment description",
        "currency" : "USD",
        "token" : "[TOKEN ID]"

})

print(authorization)

<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$authorization = Simplify_Authorization::createAuthorization(array(
        'reference' => '7a6ef6be31',
        'amount' => '1000',
        'description' => 'payment description',
        'currency' => 'USD',
        'token' => '[TOKEN ID]'
));

print_r($authorization);

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

my $authorization = Net::Simplify::Authorization->create({
    reference => "7a6ef6be31",
    amount => "1000",
    description => "payment description",
    currency => "USD",
    token => "[TOKEN ID]"
});

print "Authorization ID ", $authorization->{id}, "\n";

using SimplifyCommerce.Payments;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();

Authorization authorization = new Authorization();
authorization.Amount = 1000;
authorization.Currency = "USD";
authorization.Description = "payment description";
authorization.Reference = "7a6ef6be31";
authorization.Token = "[TOKEN ID]";

try
{
    authorization = (Authorization)api.Create(authorization);
}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}

var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.authorization.create({
    reference : "7a6ef6be31",
    amount : "1000",
    description : "payment description",
    currency : "USD",
    token : "[TOKEN ID]"
}, function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Success Response: " + JSON.stringify(data));
});
INPUT PARAMETERS
amount Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00
[min value: 50, max value: 9999900]
 required
card Credit or debit card being used to apply the payment to. optional
card.addressCity City of the cardholder.
[max length: 50, min length: 2]
 optional
card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
[max length: 2, min length: 2]
 optional
card.addressLine1 Address of the cardholder.
[max length: 255]
 optional
card.addressLine2 Address of the cardholder if needed.
[max length: 255]
 optional
card.addressState State of residence of the cardholder. State abbreviations should be used.
[max length: 255]
 optional
card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 characters in length and only contains numbers or letters.
[max length: 32]
 optional
card.cvc CVC security code of the card. This is the code on the back of the card. Example: 123 optional
card.expMonth Expiration month of the card. Format is MM. Example: January = 01
[min value: 1, max value: 12]
 optional
card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
[min value: 0, max value: 99]
 optional
card.name Name as it appears on the card.
[max length: 50, min length: 2]
 optional
card.number Card number as it appears on the card.
[max length: 19, min length: 13]
 optional
currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
[default: USD]
 required
customer ID of customer. If specified, card on file of customer will be used. optional
description Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations.
[max length: 1024]
 optional
order Detailed order information. optional
order.commodityCode Standard classification code for products and services.
[max length: 5]
 optional
order.customer ID of the customer associated with the order. optional
order.customerEmail Customer email address. optional
order.customerName Customer name. optional
order.customerNote Additional notes provided by the customer.
[max length: 255]
 optional
order.customerReference A merchant reference for the customer. optional
order.items Detailed information about individual items contained in the order. optional
order.items.amount Cost of the item. optional
order.items.description Description of the item. optional
order.items.name Item name. optional
order.items.product Product information associated with the item. optional
order.items.quantity Quantity of the item contained in the order
[min value: 1, max value: 999999, default: 1]
 required
order.items.reference A merchant reference for the item.
[max length: 255]
 optional
order.items.tax Taxes associated with the item. optional
order.merchantNote Additional notes provided by the merchant.
[max length: 255]
 optional
order.payment ID of the payment associated with the order. optional
order.reference A merchant reference for the order.
[max length: 255]
 optional
order.shippingAddress Address the products are being shipped to. optional
order.shippingAddress.city City, town, or municipality.
[max length: 255, min length: 2]
 optional
order.shippingAddress.country 2-character country code.
[max length: 2, min length: 2]
 optional
order.shippingAddress.line1 Street address.
[max length: 255]
 optional
order.shippingAddress.line2 (Opt) Street address continued.
[max length: 255]
 optional
order.shippingAddress.name Name of the entity being shipped to.
[max length: 255]
 optional
order.shippingAddress.state State or province.
[max length: 255]
 optional
order.shippingAddress.zip Postal code.
[max length: 32]
 optional
order.shippingFromAddress Address the products are being shipped from. optional
order.shippingFromAddress.city City, town, or municipality.
[max length: 255, min length: 2]
 optional
order.shippingFromAddress.country 2-character country code.
[max length: 2, min length: 2]
 optional
order.shippingFromAddress.line1 Street address.
[max length: 255]
 optional
order.shippingFromAddress.line2 (Opt) Street address continued.
[max length: 255]
 optional
order.shippingFromAddress.name Name of the entity performing the shipping.
[max length: 255]
 optional
order.shippingFromAddress.state State or province.
[max length: 255]
 optional
order.shippingFromAddress.zip Postal code.
[max length: 32]
 optional
order.shippingName Name of the entity being shipped to. optional
order.source Order source.
[default: WEB]
 required
order.status Status of the order.
[default: INCOMPLETE]
 required
reference Custom reference field to be used with outside systems. optional
replayId An identifier that can be sent to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your payments. If supplied, we will check for a payment on your account that matches this identifier, and if one is found we will attempt to return an identical response of the original request.
[max length: 50, min length: 1]
 optional
token If specified, card associated with card token will be used.
[max length: 255]
 optional
OUTPUT
card.customer.id Customer ID
card.id Unique ID of the card associated with the payment
customer.id Customer ID
id Authorization ID
payments.id Payment ID
transactionDetails.id Transaction details id
amount Amount of the authorization in the smallest unit of your currency. Example: 100 = $1.00
amountRemaining Amount of the authorizations less any payments that have been captured in the smallest unit of your currency. Example: 100 = $1.00
authCode Authorization code
captured Indicates that the authorization has had at least one successful payment capture associated with it.
capturedAmount The sum of the total amount of payments that have been captured against this authorization.
card Credit or debit card being used to apply the authorization to.
card.addressCity City of the cardholder.
card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1 Address of the cardholder.
card.addressLine2 Address of the cardholder if needed.
card.addressState State of residence of the cardholder. State abbreviations should be used.
card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer Customer associated with the card
card.customer.email Email address of the customer
card.customer.name Name of the customer
card.dateCreated Creation date in UTC millis of the card in the system
card.expMonth Expiration month of the card. Format is MM. Example: January = 01
card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource Card indicator source.
card.last4 Last 4 digits of the card number
card.name Name as appears on the card.
card.type Type of credit or debit card
currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
customer Customer associated with the authorization
customer.email Email address of the customer
customer.name Name of the customer
dateCreated Date the payment occurred in UTC millis.
declineReason Decline Reason.
description Description of authorization
expirationDate Date the authorization expires and payments can no longer be captured from it.
expired Flag indicating whether or not the authorization has expired, meaning it can no longer be used to capture payments.
paymentDate Date of authorization in UTC millis.
paymentStatus Authorization status.
payments Information about payments that have been generated from this authorization.
reference Custom reference field to be used with outside systems
replayId The replayId that was submitted with the auth create request.
reversed Indicates that the authorization has had at least one successful reversal associated with it.
reversedAmount The sum of the total amount of reversals that have been applied to this authorization.
source The source of the auth (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionData Level 2 and 3 data associated with the authorization.
transactionDetails Raw response from the payment processor.
transactionDetails.data Raw response data from the acquirer.

Authorization / Delete

Create | Delete | List | Find
INPUT PARAMETERS
id ID of the authorization to be reversed. required
OUTPUT
card.customer.id Customer ID
card.id Unique ID of the card associated with the payment
customer.id Customer ID
id Authorization ID
payments.id Payment ID
transactionDetails.id Transaction details id
amount Amount of the authorization in the smallest unit of your currency. Example: 100 = $1.00
amountRemaining Amount of the authorizations less any payments that have been captured in the smallest unit of your currency. Example: 100 = $1.00
authCode Authorization code
captured Indicates that the authorization has had at least one successful payment capture associated with it.
capturedAmount The sum of the total amount of payments that have been captured against this authorization.
card Credit or debit card being used to apply the authorization to.
card.addressCity City of the cardholder.
card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1 Address of the cardholder.
card.addressLine2 Address of the cardholder if needed.
card.addressState State of residence of the cardholder. State abbreviations should be used.
card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer Customer associated with the card
card.customer.email Email address of the customer
card.customer.name Name of the customer
card.dateCreated Creation date in UTC millis of the card in the system
card.expMonth Expiration month of the card. Format is MM. Example: January = 01
card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource Card indicator source.
card.last4 Last 4 digits of the card number
card.name Name as appears on the card.
card.type Type of credit or debit card
currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
customer Customer associated with the authorization
customer.email Email address of the customer
customer.name Name of the customer
dateCreated Date the payment occurred in UTC millis.
declineReason Decline Reason.
description Description of authorization
expirationDate Date the authorization expires and payments can no longer be captured from it.
expired Flag indicating whether or not the authorization has expired, meaning it can no longer be used to capture payments.
paymentDate Date of authorization in UTC millis.
paymentStatus Authorization status.
payments Information about payments that have been generated from this authorization.
reference Custom reference field to be used with outside systems
replayId The replayId that was submitted with the auth create request.
reversed Indicates that the authorization has had at least one successful reversal associated with it.
reversedAmount The sum of the total amount of reversals that have been applied to this authorization.
source The source of the auth (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionData Level 2 and 3 data associated with the authorization.
transactionDetails Raw response from the payment processor.
transactionDetails.data Raw response data from the acquirer.

Authorization / List

Create | Delete | List | Find

Examples

List Authorization
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

ResourceList<Authorization> authorization = Authorization.list(new PaymentsMap("max", 30));

System.out.println ("Total: " + authorization.getTotal());
for (Authorization o: authorization.getList()) {
    System.out.println(o.toString());
}

require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

val = Simplify::Authorization.list({"max" => 30})

puts "Total: #{val['total']}"
val['list'].each do |o|
    puts o.inspect
end

import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

authorizations = simplify.Authorization.list({"max": 30})

print "Total: " + str(authorizations.total)
for o in authorizations.list:
    print(o)
<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$authorization = Simplify_Authorization::listAuthorization(array("max" => 30));

print "Total: " . $authorization->total . "\n";
foreach ($authorization->list as $o) {
    print_r($o);
}

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

$authorizations = Net::Simplify::Authorization->list({max => 30});

print "Total: ", $authorizations->total, "\n";
foreach my $authorization ($authorizations->list) {
    print $authorization->{id}, "\n";
}

using SimplifyCommerce.Payments;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();


try
{
    ResourceList<Authorization> authorization = (ResourceList<Authorization>)api.List(typeof(Authorization));

    Console.WriteLine ("Total: " + authorization.Total);
    Console.WriteLine ("List: " + authorization.List.ToString());

}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}


var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.authorization.list({max: 30}, function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Total: " + data.total);

    for(var i=0; i < data.list.length; i++){
        console.log("Amount: " + data.list[i].amount);
    }
});
INPUT PARAMETERS
filter
filter.idFilter by the Authorization Id
filter.replayIdFilter by the compoundReplayId
filter.last4Filter by the card number (last 4 digits)
filter.amountFilter by the transaction amount (in the smallest unit of your currency)
filter.textFilter by the description of the authorization
filter.amountMin & filter.amountMaxThe filter amountMin must be used with amountMax to find authorizations with authorization values between the min and max
filter.dateCreatedMin*Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*Filter by the maximum created date you are searching for - Date in UTC millis
filter.depositFilter by the deposit id
filter.customerFilter using the Id of the customer to find the authorizations for that customer
filter.statusFilter by the authorization status text
filter.authCodeFilter by the authorization code (Not the authorization ID)
filter.qYou can use this to filter by the ID, the authCode or the amount of the authorization

*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates optional
max Allows up to a max of 50 list items to return.
[min value: 0, max value: 50, default: 20]
 optional
offset Used in pagination of the list. This is the start offset of the page.
[min value: 0, default: 0]
 optional
sorting Allows for ascending or descending sorting of the list. The value is a map between the property name and the sorting direction (either 'asc' for ascending or 'desc' for descending). Sortable properties are:dateCreated, amount, id, description, paymentDate optional
OUTPUT
filter Filters to apply to the list.
list Object list
max Allows up to a max of 50 list items to return.
offset Used in paging of the list. This is the start offset of the page.
sorting Allows for ascending or descending sorting of the list.
total Total number of records available

Authorization / Find

Create | Delete | List | Find

Examples

Find Authorization
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

Authorization authorization = Authorization.find("4TR6Bc");

System.out.println (authorization);

require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

authorization = Simplify::Authorization.find('4TR6Bc')

puts authorization.inspect


import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

authorization = simplify.Authorization.find('4TR6Bc')

print(authorization)
<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$obj  = Simplify_Authorization::findAuthorization('4TR6Bc');

print_r($obj);

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

$authorization = Net::Simplify::Authorization->find('4TR6Bc');

print $authorization->{id}, "\n";

using SimplifyCommerce.Payments;
using Newtonsoft.Json;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();


try
{
    String id = "1234";

    Authorization authorization = (Authorization)api.Find(typeof(Authorization), id);

    // output all properties
    Console.WriteLine(JsonConvert.SerializeObject(authorization).ToString());
}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}


var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.authorization.find("4TR6Bc", function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Success Response: " + JSON.stringify(data));
});
INPUT PARAMETERS
id Object ID required
OUTPUT
card.customer.id Customer ID
card.id Unique ID of the card associated with the payment
customer.id Customer ID
id Authorization ID
payments.id Payment ID
transactionDetails.id Transaction details id
amount Amount of the authorization in the smallest unit of your currency. Example: 100 = $1.00
amountRemaining Amount of the authorizations less any payments that have been captured in the smallest unit of your currency. Example: 100 = $1.00
authCode Authorization code
captured Indicates that the authorization has had at least one successful payment capture associated with it.
capturedAmount The sum of the total amount of payments that have been captured against this authorization.
card Credit or debit card being used to apply the authorization to.
card.addressCity City of the cardholder.
card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
card.addressLine1 Address of the cardholder.
card.addressLine2 Address of the cardholder if needed.
card.addressState State of residence of the cardholder. State abbreviations should be used.
card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
card.customer Customer associated with the card
card.customer.email Email address of the customer
card.customer.name Name of the customer
card.dateCreated Creation date in UTC millis of the card in the system
card.expMonth Expiration month of the card. Format is MM. Example: January = 01
card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
card.indicatorSource Card indicator source.
card.last4 Last 4 digits of the card number
card.name Name as appears on the card.
card.type Type of credit or debit card
currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
customer Customer associated with the authorization
customer.email Email address of the customer
customer.name Name of the customer
dateCreated Date the payment occurred in UTC millis.
declineReason Decline Reason.
description Description of authorization
expirationDate Date the authorization expires and payments can no longer be captured from it.
expired Flag indicating whether or not the authorization has expired, meaning it can no longer be used to capture payments.
paymentDate Date of authorization in UTC millis.
paymentStatus Authorization status.
payments Information about payments that have been generated from this authorization.
reference Custom reference field to be used with outside systems
replayId The replayId that was submitted with the auth create request.
reversed Indicates that the authorization has had at least one successful reversal associated with it.
reversedAmount The sum of the total amount of reversals that have been applied to this authorization.
source The source of the auth (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionData Level 2 and 3 data associated with the authorization.
transactionDetails Raw response from the payment processor.
transactionDetails.data Raw response data from the acquirer.