Paycodes

Having the ability to send requests for payment to your customers is achieved through Paycodes.

Paycode is an object which represents the information about what customer needs to pay, together with the payment amount and the reference used to actually pay.

There is no limit on how many times a customer (or how many different customers) can pay using the same Paycode, but if you wish you can set a time limit before the Paycode expires and can be no longer used.

There are several ways you can use a Paycode in your payment workflow, the most simple being just copy-pasting the url property, with the secure URL customer can pay on, and sending it to your customer by email during your usual proposal-to-payment process.

Paycodes can be created through the API or through the Administration tool.

Object properties

uid

Unique ID of the Paycode in our system

amount

Amount customer needs to pay

currencyCode

3-letter ISO 4217 currency code (e.g. EUR). See a list

orderId

ID of the order in your system. This property is very useful as it is shown in the Administration tool and various reports, making it easy for you to reconcile a particula payment with your orders.

description

A short note (not longer than 150 characters) to the customer during the payment process, describing the purpose of the payment. No HTML tags are allowed.

code

Simple, uppercase reference code for this Paycode, usable by humans, e.g. AD1FE

url

An URL to which customer can be redirected to pay.

reserveFundsOnly

Describes if this payment if done by credit card should be charged to the customer's card immediately, or just reserve the funds on the card (for a later capture).

saveInSafe

Describes if the Customer, Address and Card objects should be created on the gateway on a successful payment. Useful if you wish to charge this Customer later for additional services.

validUntil

Timestamp which tells when this Paycode will expire. Expires Paycodes cannot be used anymore and will show an expired error message when accessed.

created

Object creation timestamp