Credit

Last Updated: June 11, 2024

What's in this article?

Credit money back to a payment method.

A credit can be to one of 3 different types of sources:

  • Credit Card: This requires passing fields with credit card data.
  • Credit Card Magstripe: This requires passing magstripe data from a swiped credit card.
  • Check
  • Source: This includes crediting based on a previous transaction, a stored payment method, or a token.

This feature must be enabled by the ISO/MSP. It requires the Refund permission on the source key for CC transactions, and Check Refund for checks.


One of 
Credit with Credit Card NumberCredit with MagstripeCheck / ACH CreditSource Credit

card
required

Card number

expiry_month
required

Card expiration month. If using a card token, send any valid month.

expiry_year
required

Card expiration year. If using a card token, send any valid year.

amount
required

Amount to credit.

avs_address

Billing address for the card.

avs_zip

Billing zip code for the card.

While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions.

cvv2

Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back.

While not required, this field should be populated for fraud prevention.

name

Name on card

customer
object

transaction_details
object

Additional optional transaction details.

transaction_flags
object (TransactionFlags)

These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates.

custom_fields
object (CustomFields)
Help us improve. Was this article helpful?