Recurly Payment Gateway

This page details the inputs, secure inputs and outputs available for the Recurly payment gateway, how to complete each field, and an external link to the Recurly integration documentation.

PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.

Inputs

Input Fields	Required	Character Limits/Required Input	Description
billingFirstName	Yes	char	Card holder’s last name
billingLastName	Yes	char	Card holder’s first name
billingAddress1	Yes	char	Billing address line 1
billingCity	Yes	char	Billing city
billingCountry	Yes	2 char	Billing country code. 2 letter ISO code.
billingState	Yes	char	Billing state or region
billingZip	Yes	char	Billing zip or postal code
shippingFirstName	No	255 char	The first name for the shipping address.
shippingLastName	No	255 char	The last name for the shipping address.
shippingAddress1	No	char	Address line 1 for the shipping address
shippingCity	No	char	City for the shipping address
shippingCountry	No	2 char	Shipping address country. 2 letter ISO code
shippingState	No	char	State or region for the shipping address
shippingZip	No	char	Zip or postal code for the shipping address
shippingNickname	No	char	A nickname for the shipping address. Defaults to “shippingFirstName” ShippingLastName”. Max of 255 characters.
subscriptionPlanCode	No	50 char	plan_code for the subscription. Identifies a subscription which defines the amount etc.
adjustmentAmount	No	8 num	Positive amount for a charge, negative amount for a credit. Max 10000000.
adjustmentCurrency	No	3 char	Currency, 3-letter ISO code.
adjustmentQuantity	No	num	The number of adjustments
adjustmentProductCode	No	50 chars	The product code or SKU of the line item.
adjustmentScheduleType	No	Available schedule types are “never”, “at_range_start”, “at_invoice”, and—if “end_date” is set—“evenly” and “at_range_end”	Optional field for setting a revenue schedule type. This will determine how revenue for the associated adjustment should be recognized.
adjustmentDescription	No	50 char	Description of the adjustment for the invoice.
giftCardCode	No	50 char	A gift card to apply to the transaction. The gift card is reported as a “credit” in the response.
couponCode	No	50 char	A coupon code to apply to the transaction. This is reported as “couponDiscount” in the response.
poNumber	No	num	A PO number for the resulting invoice. Manual invoicing must be enabled on your site to use po_number with this endpoint
collectionMethod	Yes	automatic or manual	The collection method for the invoice.
currency	No	3 char	The currency for the transaction. 3 character ISO code.
campaign	No	10 num	The campaign ID for account acquisition to associate the customer with a specific campaign, if applicable.
email	No	50 char	The email address for the account.
accountCode	Yes	50 char	A unique identifier used by your application to identify the account. This code may only contain the following characters: [a-z 0-9 @ - _ .] but it may not begin with a dot or hyphen character.

Secure Inputs

Output Fields	Description
number	Secure input of the card number. Supports spaces and dashes.
fullExpiry	Secure input of the card expiry - in the format MMYY
cvv	Secure input of the card CVV, either three or four digits long depending on the card

Outputs

Output Fields	Description
uuid	The unique identifier of the transaction
State	The state of invoices to return: pending, paid, failed, past_due, open, closed, voided, or processing
accountCode	Reference for the customer account that was created as part of the transaction
invoiceNumber	Number for the invoice supplied by Recurly
taxInCents	Amount of tax or VAT within the transaction, in cents.
createdAt	Date the transaction took place.
updatedAt	Date the transaction was last modified.
attemptNextCollectAt	The date that the next collection will be attempted
dueOn	When the invoice needs to be paid. This will be the fate and time of the transaction in most cases.
balanceInCents	The amount remaining on the invoice
refundableTotalInCents	The amount that can be refunded in a later refund transaction
collectionMethodOut	Collection method as sent in the request
type	The type of transaction
origin	Describes how the transaction was triggered. May be one of (api,hpp,merchant,recurly_admin,recurlyjs,recurring,transparent,force_collect,refunded_externally,chargeback).
startDate	A timestamp associated with when the subscription began. Usually the date and time of the transaction
endDate	A timestamp associated with when the subscription will end.
cvvResult	CVV result, if applicable.
avsResult	AVS result, if applicable.
avsResultStreet	AVS result for the street address, line 1.
avsResultPostal	AVS result for the postal code
currencyOut	The currency for the transaction, usually defined by the subscription details.
adjustmentUnitAmount	Unit amount of the adjustment
adjustmentQuantityOut	Number of units
adjustmentTotalAmount	Unit amount * quantity
subscriptionUnitAmount	Unit amount of the subscription
subscriptionQuantity	Number of units for the subscription
subscriptionTotalAmount	Unit amount * quantity
couponDiscount	The amount being discounted as a result of a coupon being provided on the transaction
totalBeforeDiscount	The total of the invoice before any coupon discounts
grandTotal	Grand total of the invoice, taking into account any coupon discounts
creditUnitAmount	The amount for a single credit unit
creditTotalAmount	Total Amount of the credit payment.
creditCurrency	Currency for the credit transaction, 3-letter ISO code.
amountPaid	The amount that was actually captured from the provided card, taking into consideration any discounts and credits
poNumberOut	poNumber as sent in the request
errorCode	For declined transactions, the error code (if applicable).
errorCategory	For declined transactions, the error category (if applicable).
merchantMessage	An error message that should be reserved for the merchant/agent to view only.
customerMessage	An error message that can be relayed to the card holder, if necessary
gatewayErrorCode	For declined transactions, this field lists the gateway error code sent to Recurly from the gateway (if applicable).
reference	Reference for the error
errorUuid	UUID for the error
lastFour	Last four digits of the provided card number
fieldErrorMessage	Error message specifying a specific field where there is an issue

Further information can be found by viewing the integration documentation:

Recurly API Documentation

Recurly Payment Gateway

Inputs

Secure Inputs

Outputs

The help manual was created with Dr.Explain