Attributes on a credit card agreement
When creating a recurring credit card agreement, you will see different extra-attributes on the document.
Some are mandatory, others can be added to display additional information from your payment provider or used
to pass a value.
Attributes
- amount: the amount of first payment when signing the agreement (zero-amount is supported by some payment providers)
- _cust: The customer ID from your payment service provider
- _psptoken: The reference token to the credit card agreement from your payment service provider
- _cctype: Card type used (only returned by some payment providers)
- _last: The last 4 digits of the card used to sign
- _expiry: The expiry date of the card (only returned by some payment providers)
- pl_: The payment link ID used to sign the agreement (first payment)
- method: A specific signing method can be passed when creating the agreement (visa, mastercard)
Expiry of the card
In case we received the expiry date back from your payment service provider a task will be created on the agreement.
The tasks will run 30 days prior to the actual expiry of the card and try to renew the credit card if possible.
In case we couldn't renew the credit card we send a notification.
If we did not receive the expiry from your payment provider, then we log it in the events of the agreement.
Method
When you only want your customer to use a specific card type when signing, you can add the attribute 'method'.
A default value can be assigned to it or you can assign a value when creating a new agreement. Currently you can use visa and mastercard
as value.