Payze

This is documentation of PAYZE (Payment Service Provider), which comprehensively describes the services related to online payments, card saving, and money transfer. For 🇬🇪 Georgian version please <a href="https://app.theneo.io/payze/ge">click here&nbsp;</a>

Payze API Reference

Signing up for an account is quick and easy! If you have not already, you can sign up here <a href="https://payze.io/sign-up">https://payze.io/sign-up</a> If you are an existing user you can go to your <a href="https://payze.io/api-keys">dashboard</a> and copy the API key and secret that you will use to authenticate all requests to the API. Please remember that the API key should be treated like any other password. &nbsp;Do not disclose or share your API key with anyone else! We strongly recommend using a secrets manager. Plain text files like dotenv lead to accidental costly leaks. Use <a href="https://www.doppler.com/">Doppler</a> for a developer-friendly experience. AWS and Google Cloud have native solutions as well.

Getting Started

The set of APIs below allows you to accept a variety of payment methods through a single API Provide feedback for the single payments&nbsp;

Single payments

Standard payment service that allows execution of a single payment. For the implementation of the service, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="16efd602-7516-428d-9b39-a7bf23173d3d-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SUCCESS_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is successful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>FAIL_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is unsuccessful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PREAUTHORIZE</td><td>&nbsp;</td><td>&nbsp;</td><td>(not required) If the parameter is set to true, the funds will be blocked on the cardholder's account and will be transferred to the merchant after the commit command is executed. Possible values: true, false. default value: false.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>IMAGE_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>An URL of the image, that appears on the payment page;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAYMENT_NAME</td><td>&nbsp;</td><td>&nbsp;</td><td>short name of the payment.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAYMENT_DESCRIPTION</td><td>&nbsp;</td><td>&nbsp;</td><td>Description of the payment. 1000 characters max;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>LANG</td><td>&nbsp;</td><td>&nbsp;</td><td>Parameter to choose the language with (EN, GE)</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Just Pay

Standard payment service that allows an execution of a single payment. For the implementation of the service, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="87405dfd-3c0f-43b2-b4aa-cbe47dc7720e-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SUCCESS_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is successful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>FAIL_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is unsuccessful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PREAUTHORIZE</td><td>&nbsp;</td><td>&nbsp;</td><td>(not required) If the parameter is set to true, the funds will be blocked on the cardholder's account and will be transferred to the merchant after the commit command is executed. Possible values: true, false. default value: false.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>IMAGE_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>An URL of the image, that appears on the payment page;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAYMENT_NAME</td><td>&nbsp;</td><td>&nbsp;</td><td>short name of the payment.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAYMENT_DESCRIPTION</td><td>&nbsp;</td><td>&nbsp;</td><td>Description of the payment. 1000 characters max;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>LANG</td><td>&nbsp;</td><td>&nbsp;</td><td>Parameter to choose the language with (EN, GE)</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Just Pay with product Info

Payment service with split function. After successful completion of the service, transaction costs will be divided to all participants according to the proportions specified in parameters. With this service, you can make a single payment. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="63c42e83-3405-416b-9486-81c1cbfb81ec-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CALLBACK</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is successful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CALLBACK_ERROR</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is unsuccessful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>IBAN</td><td>&nbsp;</td><td>&nbsp;</td><td>A third-party bank account, on which the specified amount will be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SPLIT_AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Share of the amount that has to be transferred to the third-party account, It has to be less than the transaction value;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAY_IN</td><td>&nbsp;</td><td>&nbsp;</td><td>Number of days after which the split amount is transferred to the receptionist. The number must be in a numeric format Int, for example 5 and not "5".</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PREAUTHORIZE</td><td>&nbsp;</td><td>&nbsp;</td><td>(not required) If the parameter is set to true, the funds will be blocked on the cardholder's account and will be transferred to the merchant after the commit command is executed. Possible values: true, false. default value: false.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Just Pay and Split

​​Payze allows you to collect card details and charge your customer at a later time. The API functions listed below enable you to save customers' credit card information and conduct transactions later. Provide feedback about capture methods bellow

Capture card

Payze enables you to securely save a customer's credit card information and execute transactions later. The service responds with a token associated with the specified card, and upon successful saving of the operation, further transactions can be produced. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required If the first transaction is while saving the card, which is deducted from the cardholder. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="97490685-852c-41cc-b30f-6fa995fae0ca-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SUCCESS_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is successful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>FAIL_URL</td><td>&nbsp;</td><td>&nbsp;</td><td>A user will be redirected to this address if the transaction is unsuccessful;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Add Card

Service of accepting payment using saved card token. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="b199fff0-d481-4eab-940e-5c5cc9b807d9-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CARD_TOKEN</td><td>&nbsp;</td><td>&nbsp;</td><td>Saved card token</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PREAUTHORIZE</td><td>&nbsp;</td><td>&nbsp;</td><td>(not required) If the parameter is set to true, the funds will be blocked on the cardholder's account and will be transferred to the merchant after the commit command is executed. Possible values: true, false. default value: false.</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Pay With Card

A payment service employing a saved card token, upon which the transaction's cost is distributed among all participants in accordance with the proportions stated in the parameters. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="bc1c764d-d525-4a5e-ae65-8a7ddd357c12-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CARD_TOKEN</td><td>&nbsp;</td><td>&nbsp;</td><td>Saved card token</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>IBAN</td><td>&nbsp;</td><td>&nbsp;</td><td>A third-party bank account, on which the specified amount will be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SPLIT_AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Share of the amount that has to be transferred to the third-party account, It has to be less than the transaction value;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PAY_IN</td><td>&nbsp;</td><td>&nbsp;</td><td>Number of days after which the split amount is transferred to the receptionist. The number must be in a numeric format Int, for example 5 and not "5".</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>CURRENCY</td><td>&nbsp;</td><td>&nbsp;</td><td>Possible values: USD, GEL;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>PREAUTHORIZE</td><td>&nbsp;</td><td>&nbsp;</td><td>(not required) If the parameter is set to true, the funds will be blocked on the cardholder's account and will be transferred to the merchant after the commit command is executed. Possible values: true, false. default value: false.</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Pay With Card And Split

If you have any questions or feedback, feel free to share it with us bellow&nbsp;

General

Service of retrieving transaction information using the identifier, which was returned during the transaction generation process. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="66cda1b1-d1d2-4c88-83b2-146e3ac62bbb-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>TRANSACTION_ID</td><td>&nbsp;</td><td>&nbsp;</td><td>Identifier of a transaction</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Get Transaction Information

Service of refunding transaction value back to a cardholder using the ID which was returned while generating the transaction. Using this service, it is possible to return both: partial and full transaction amounts for the transactions performed using standard payments or saved cards. In order to do so, <code>API_KEY</code> and <code>API_SECRET</code> are required. Restriction: Transactions that involve splitting logic can only be returned with a full refund. ⚠️ Note: not filling the AMOUNT field will be perceived as a full refund.

Refund Transaction

Service is used to withdraw a blocked amount of funds from a card owner's bank account while generating the transaction. Using this service, it is possible to withdraw both: partial and full transaction amounts for the transactions performed using standard payments or saved cards. Restriction: Transactions that involve splitting logic (Just Pay &amp; Split) can only be withdrawn with a full amount. ⚠️ Note: not filling the variable AMOUNT in the service will be perceived as a full withdrawal. <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="4a70abd0-826d-4ea8-824d-d71075557548-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>TRANSACTION_ID</td><td>True</td><td>&nbsp;</td><td>Identifier of a transaction</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>AMOUNT</td><td>&nbsp;</td><td>&nbsp;</td><td>Transaction value to be transferred;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure>

Commit Transaction

Service used to updated Split details Old split list gets overwritten by the new one <figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="4a70abd0-826d-4ea8-824d-d71075557548-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>API_KEY</td><td>True</td><td>&nbsp;</td><td>API key, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>API_SECRET</td><td>True</td><td>&nbsp;</td><td>API secret, obtained from a merchant's dashboard;</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>TRANSACTION_ID</td><td>True</td><td>&nbsp;</td><td>Identifier of a transaction</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>SPLIT</td><td>&nbsp;</td><td>&nbsp;</td><td>New splits to replace old ones with</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure> ⚠️ Note: Split cannot be updated after transaction has been committed

Split Update

API Reference

This is documentation of PAYZE (Payment Service Provider), which comprehensively describes the services related to online payments, card saving, and money transfer. For 🇬🇪 Georgian version please <a class="slate-a" href="https://app.theneo.io/payze/ge" target="_blank">click here </a>

Signing up for an account is quick and easy! If you have not already, you can sign up here <a class="slate-a" href="https://payze.io/sign-up" target="_blank">https://payze.io/sign-up</a> If you are an existing user you can go to your <a class="slate-a" href="https://payze.io/api-keys" target="_blank">dashboard</a> and copy the API key and secret that you will use to authenticate all requests to the API. Please remember that the API key should be treated like any other password.  Do not disclose or share your API key with anyone else! We strongly recommend using a secrets manager. Plain text files like dotenv lead to accidental costly leaks. Use <a class="slate-a" href="https://www.doppler.com/" target="_blank">Doppler</a> for a developer-friendly experience. AWS and Google Cloud have native solutions as well.

The set of APIs below allows you to accept a variety of payment methods through a single API Provide feedback for the single payments

​​Payze allows you to collect card details and charge your customer at a later time. The API functions listed below enable you to save customers&apos; credit card information and conduct transactions later. Provide feedback about capture methods bellow

If you have any questions or feedback, feel free to share it with us bellow

Sections