• User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

  • User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes
  1. Home
  2. Docs
  3. Heartland – Dev Portal
  4. Transactions Processing
  5. Credit Card Transactions
  6. Credit
Updated on June 9, 2023

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes

Credit

Credit transaction in use:

  1. Money transfer between two credit cards
  2. Money transfers in gaming industry
  3. Money back operations

The difference between Refund and Credit transaction types, is that Refund is based on a previous (parent) transaction (e.g. Charge).

Request Parameters

 NameTypeRequiredDescription
 accountIdinteger✓

Platform Account identifier.

Must be greater than 0.
 accountOwnerIdstringoptionalCredit Card Account Owner ID.
MaxLength(50)
 amountdecimal✓

Transaction amount.

Value ≥ 0 (2 decimal places)
 billingAddressobjectoptionalUser Billing Address data object.
 billingOverrideobjectoptionalData object that contains an array of billingFee objects.
 creditCardobjectconditional

Credit Card data object.

Required if
payment method = CreditCard.
 achobjectconditional

ACH data object.

Required if payment method = ACH.
 currencyenum✓

currencyTypeId

Available Values:
 
CurrencyId
USD1
EUR2
CAD6
GBP4
AUD5
SGD11
JPY23
NZD32
ILS8
 merchantDataobjectoptionalMerchant Data data object.
 entryModeintegeroptional

Nullable

Transaction entry mode numerical value.
 paymentMethodenum✓

PaymentMethod enum values.

Available Values:
 
creditCard0Credit card payments
ach1ACH payments
 processorDataobjectoptionalProcessor Data data object.
 subAccountIdinteger✓

Sub-Account identifier.

Value ≥ 0
 terminalIdstringoptional

transactionMethodId.

MaxLength(20)
 transactionMethodenumoptional

transactionMethodId.

Available Values:
 
RegularTransaction0
MailOrTelephoneOrder1
InternetTransaction2
3DSecureTransaction3
PointOfSaleTransaction4
BillpayTransaction5
RecurringTransaction6
 typeenum✓
transactionTypeId.
Available Values:
 
Credit
				
					//Credit request example

{
  "accountId": "Platform Account Id",
  "accountOwnerId": "СС Account Owner ID",
  "amount": 13,
  "billingAddress": {
    "addressLine": "Address",
    "city": "City Name",
    "country": "USA",
    "email": "email@mail.com",
    "phoneNumber": "12346879",
    "state": "FL",
    "zipPostalCode": "123465798"
  },
  "billingOverride": [
    {
      "fixedAmount": "feeFixedAmount",
      "id": "objectId",
      "percentageAmount": "feePercentageAmount",
      "sourceId": "feeSourceIdentifier",
      "sourceType": "BillingAccountId",
      "targetId": "feeTargetIdentifier",
      "targetType": "BillingAccountId",
      "reverse": "true",
      "billingAmount": "billingAmountValue"
    }
  ],
  "creditCard": {
    "number": "4111111111111111",
    "expirationDate": "1225",
    "nameOnCard": "Eleanor Johansson",
    "type": "Visa",
    "cvv": "123"
  },
  "currency": "USD",
  "merchantData": {
    "freeText": "string",
    "transactionDate": "dateTime",
    "transactionDescription": "string",
    "transactionId": "string"
  },
  "entryMode": "2",
  "paymentMethod": "CreditCard",  
  "processorData": {
    "dynamicDescriptor": "01919Z"
  },
  "subAccountId": "Sub-Account Id",
  "terminalId": "string",
  "transactionMethod": "RegularTransaction",
  "type": "Credit"  
}				
			
Still stuck? How can we help?
Was this page helpful? Yes No

How can we help?

© Amaryllis Payment Solutions, 2022  All rights reserved.