Public developer access to the OlyCash API is currently invite-only. Please contact us with your use-case details for evaluation.
Field Required
DESCRIPTION
 Notes

Item Details
olycash__item_id DEPENDS The item ID registered with OlyCash. Required for cost and shipment tracking for items previously submitted by the seller to OlyCash or through its sister site (OlyPages). It is included in any static plugin specific to an item or can automatically be included by the developer for dynamic pages loading items from OlyCash. Other Item Details are not required if this field is provided.
olycash__sku NO The item Stock Keeping Unit (SKU) to enable tracking of the item for your business. Used for tracking items to be sold more than one time and for the seller’s internal business inventory tracking. For one-off sales, such as a vintage items, it is not required but may help prove authenticity.
olycash__name DEPENDS
 The name of the item as used in your business.
 Required if the olycash__item_id is not provided.
olycash__image DEPENDS An image to represent the item. Required if the olycash__item_id is not provided.
olycash__url NO A permanent URL to refer to the item on the seller’s website for user followup during purchases. If not provided, the current location of the plugin is taken as the item permanent URL on submission of the payment.
olycash__unit_measurements DEPENDS The shipping dimensions of the item. They are Length x Width x Height measurements of the final shipping box. This value is required if the seller desires to use OlyCash shipping system for fulfillment. This value is submitted in the format “10x60x80”. The measurements are in centimeters (1 meter = 100 centimeters). There are no spaces or other letters in the value.

Flags
ignorefrequency NO Instruction to ignore the payment frequency. The payer is not shown an option to choose the payment option if this flag is set to "Y" and the payments are expected to be one_time purchases.
cardprocessor NO The preferred processor to complete a card purchase. The default processor is "stripe". Options: stripe, paypal
phoneprocessor NO The preferred processor to complete a phone purchase. The default processor is "beyonic". Options: beyonic
cryptoprocessor NO The preferred processor to complete a crypto purchase. The default processor is "coinbase". Options: coinbase

Participant Details
olycash__buyer_telephone DEPENDS The buyer’s mobile phone number. Required if the olycash__buyer_email is not provided. At least one or more contacts for the buyer is required.
olycash__buyer_email DEPENDS The buyer’s email address Required if the olycash__buyer_telephone is not provided. At least one or more contacts for the buyer is required.
olycash__buyer_name NO The buyer’s full name. This is expected in the format: [First Name] [Last Name]
olycash__seller_name NO The seller’s full name. If the seller wants to show a different name (instead of the registered name with OlyCash) for receipt and communication purposes regarding this transaction, then they set that name in this field. This could be the “trading as” name, brand name or any other unique name officially owned by the seller.
olycash__note NO The transaction note. Include any notes to be attached to the transaction and only visible to the seller in the OlyCash dashboard.

Cost Details
olycash__shipping DEPENDS The shipping charge for this transaction. Include if the item is not in-store or pickup_only. This value is required if the seller desires to use OlyCash shipping system for fulfillment.
olycash__insurance NO The insurance for the item. Include if you want to track this separately of the transaction total and the item requires insurance as per seller’s government regulations or the seller’s service guarantee.
olycash__tax NO The tax payable on the sale. Include this amount to track separately from the transaction total and if the sale is taxable as per seller’s government regulations.
olycash__price NO The price of a single unit of the item. Include this amount to track separately from the transaction total. In cases where a discount is provided on the price, the gross price is set here.
olycash__price_discount NO The discount provided on the item gross price. Include this value if a discount is provided on the item. The unit of the discount is the price currency. Therefore, the percentage needs to be converted to the actual amount.
olycash__total YES The total charge to the buyer.  
olycash__currency YES The currency of the charges to the buyer. This currency is also used for any monetary amounts entered for other plugin fields.
olycash__third_party_fee_paid_by NO The transaction party responsible for any third-party processing fees. This does not include OlyCash fees. Can be payer or payee
olycash__sale_split NO The instructions to split the net amount after the sale is completed.
This is expected in the format: [user_id1=percent1]|[user_id2=percent2]|etc
If the percent is less than 100% the remainder is left with the olycash__item_id seller. If it exceeds 100%, the instruction is ignored.
olycash__pay_frequency NO The payment frequency for repeatable transactions.
Preset the payment frequency for repeatable transactions. This sets the frequency of the payment to one of the following options:
one_time(default), daily, weekly, monthly, annual
Displayed as:
One Time, Daily, Weekly, Monthly, Annual
respectively.
Please note that the user can still change the payment frequency (such as from monthly to one_time) if they can not afford the preset agreement.

Shipping Details
olycash__quantity NO The quantity of the items bought in this purchase. The default is assumed as 1 if this value is not provided.
olycash__quantity_label NO The label of the unit of the item. Can be Kgs, Lbs, Pairs, etc
olycash__destination_address DEPENDS The destination of the item. This value is required if the seller desires to use OlyCash shipping system for fulfillment. It is submitted in the format: latitude=[latitude]|longitude=[longitude]| zipcode=[zip code]|country=[2 char code of country]|city=[city]|googleid=[Google-Places ID for quicker directions]| instructions=[User provided instructions] Only the latitude and longitude fields are required for this field but the others help speed up guidance for directions and shipping process.
olycash__will_pickup NO Will the buyer pick up the item from this sale? Set to “Y” if the buyer will pickup the item. Set to “N” or do not include if this is not the case.
olycash__pickup_only NO Is this item only to be picked up by the buyer or their authorized representative? Set to “Y” if this item has to be picked up. Set to “N” or do not include if this is not the case.
olycash__shipping_option_id DEPENDS The ID of the chosen shipping option for transporting the item sold. This value is required if the seller desires to use OlyCash shipping system for fulfillment. It is provided by OlyCash after the shipping option is chosen.
olycash__pickup_address DEPENDS The address where the item can be picked up. This value is required if olycash__will_pickup is set to “Y” or olycash__pickup_only is set to “Y”

Pre/Post Processing Function Details
olycash__pre_process NO The JavaScript function that should be called before processing the payment submission. For security reasons, this function does not directly pass any values to OlyCash. However, it can be used to set or check the payment field details before submission.
olycash__post_process NO The JavaScript function that should be called to get a synchronous response of a third-party processor. This field is available for the following payment methods: Debit Code (Code tab), Credit Code (Credit tab).
If this value is set, the response data from the purchase submission is also sent to this function. 
For example, if the value of this field is “olycashPostProcess” 
 
The function is created like so: 
 
function olycashPostProcess(data){
     // Your code here to handle {data}
     // data.message = response message (Possible values: success, cancelled, fail)
     // data.purchase_id = the ID of the purchase for future tracking. Empty if not successful.
}