Skip to main content
Vindicia Knowledge Center

The payment_method object

The payment_method object

Attributes

PaymentMethod
Name Type Description
object string Value is “PaymentMethod”
id string A merchant-specified unique identifier. Optionally, this object can be identified by its vid.
vid string A Globally Unique Identifier (GUID) for this object. This field is created by CashBox.
created datetime The date/time the object was created.
type enum Values can be Amazon,ApplePay,Boleto,CarrierBilling,CreditCard,DirectDebit,ECP,HostedPage,MerchantAcceptedPayment,PayPal,Skrill,Token
credit_card CreditCard Credit Card details.
ecp ECP ACH (aka ECP) details.
direct_debit DirectDebit Direct Debit details (vary by country/system)
paypal PayPal PayPal Express Checkout account details.
amazon Amazon Amazon Payments account details.
skrill Skrill Skrill digital wallet details.
boleto Boleto Boleto Bancario details.
hosted_page HostedPage Externally Hosted Payment Page details.
token Token Token (payment method) details.
merchant_accepted_payment MerchantAcceptedPayment Pay By Invoice details.
carrier_billing CarrierBilling Telco carrier billing details.
apple_pay ApplePay Apple Pay details.
metadata hash A set of key/value pairs that you can attach to an object. Useful for storing additional information.
account_holder string Name of the account holder.
billing_address Address The official billing address associated with this paymentmethod.
customer_specified_type string Optional merchant- or customer-specified type description.
customer_description string Optional merchant- or customer-specified card (method) description.
currency string An ISO 4217 Currency Code.
primary boolean Primary/default payment method for the account.
active boolean Active and available for use.
validation_transaction Transaction Transaction used to validate this paymentmethod.
policy hash The policy object governing Payment Method behavior.
CreditCard
Name Type Description
object string Value is “CreditCard”
vid string A Globally Unique Identifier (GUID) for this object. This field is created by CashBox.
account string The Primary Account Number (PAN) aka Credit Card Number (encrypted/hidden when returned)
bin string The first 6 digits of the PAN (Bank Identifier Number)
last_digits string The last 4 digits of the PAN
account_length integer The number of digits in the PAN
hash_type enum The algorithm used for hashing the account number. If this value is not provided we assume SHA1. Values can be sha1,md5
account_hash string A hash of the PAN.
expiration_date string Expiration Month and Year
extended_card_attributes ExtendedCardAttributes Extended Card Attributes
cvn string CVV (Card Verification Value) or CVN (Card Verification Number) printed on the card.
ExtendedCardAttributes
Name Type Description
object string Value is “ExtendedCardAttributes”
commercial_card integer  
consumer_card integer  
credit_card integer  
debit_card integer  
signature_debit_card integer  
pinless_debit_card integer  
gift_card integer  
prepaid_card integer  
payroll_card integer  
healthcare_card integer  
virtual_account_number integer  
reloadable integer  
country_of_issuance string  
durbin_regulated integer  
affluent integer  
mass_affluent integer  
card_description string  
PayPal
Name Type Description
object string Value is “PayPal”
paypal_email string PayPal Email Address of User
payer_id string PayerID
return_url string The URL to which you would like customers to be redirected after they have successfully completed payment transactions on the PayPal site. This is often your confirmation page, on which the customer confirms the order and payment or the billing agreement.
cancel_url string The URL to which you would like to redirect customers if PayPal indicates failure after they have completed the payment process on the PayPal site.
request_reference_id boolean When processing the initial Transaction for a Subscription, ask PayPal for a Reference ID that can be used in the future for recurring billing. This works only if you have been previously approved for Reference Transactions by PayPal.
reference_id string PayPal field “REFERENCEID” which is the Billing Agreement ID or Reference Transaction ID associated with a PayPal Billing Agreement. If you enter a value for this data member, set requestReferenceId to false.
  • cURL
  • Java
Example Object
{
    "object": "PaymentMethod",
    "id": "paym_1235",
    "vid": "97b0915f6e65614462fdee6ffbc8385f3308188f",
    "created": "2016-05-24T17:41:29-07:00",
    "type": "CreditCard",
    "credit_card": {
        "object": "CreditCard",
        "vid": "0f0c86caef22b95b80f430cd4f8fc2df52a03f97",
        "account": "422277XXXXXX9507",
        "bin": "422277",
        "last_digits": "9507",
        "account_length": 16,
        "expiration_date": "201805"
        },
    "account_holder": "Sally W. Brown",
    "billing_address": {
        "object": "Address",
        "vid": "2eec375cdf13cd4998346796995099146448a651",
        "name": "Sally Brown",
        "line1": "123 Main Street",
        "city": "San Francisco",
        "district": "CA",
        "postal_code": "94105",
        "country": "US",
        "phone": "415-555-3212"
        },
    "customer_specified_type": "VI",
    "primary": true,
    "active": true
}
{
    "object": "PaymentMethod",
    "id": "paym_1235",
    "vid": "97b0915f6e65614462fdee6ffbc8385f3308188f",
    "created": "2016-05-24T17:41:29-07:00",
    "type": "CreditCard",
    "credit_card": {
        "object": "CreditCard",
        "vid": "0f0c86caef22b95b80f430cd4f8fc2df52a03f97",
        "account": "422277XXXXXX9507",
        "bin": "422277",
        "last_digits": "9507",
        "account_length": 16,
        "expiration_date": "201805"
        },
    "account_holder": "Sally W. Brown",
    "billing_address": {
        "object": "Address",
        "vid": "2eec375cdf13cd4998346796995099146448a651",
        "name": "Sally Brown",
        "line1": "123 Main Street",
        "city": "San Francisco",
        "district": "CA",
        "postal_code": "94105",
        "country": "US",
        "phone": "415-555-3212"
        },
    "customer_specified_type": "VI",
    "primary": true,
    "active": true
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top