# Requests

Collection of possible requests

# Create [POST]

<span style="background-color: #c2e0f4;">**https://api.paiwise.com/checkout/create**</span> \[POST\]

<table border="1" id="bkmrk-amount-int-smallest-" style="border-collapse: collapse; width: 100%; height: 433.141px;"><tbody><tr><td style="width: 33.2922%;">identifier (optional)</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">Identifier of the checkout, if not passed the cid will get as reference</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">amount</td><td style="width: 33.2922%; height: 63.3906px;">int</td><td style="width: 33.2922%; height: 63.3906px;">Smallest nominee for the currency. Example: 30SEK is 3000 öre so value of this param should be 3000</td></tr><tr style="height: 29.7969px;"><td style="width: 33.2922%; height: 29.7969px;">currency</td><td style="width: 33.2922%; height: 29.7969px;">String</td><td style="width: 33.2922%; height: 29.7969px;">EUR, SEK, USD… etc</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2922%; height: 46.5938px;">message</td><td style="width: 33.2922%; height: 46.5938px;">String</td><td style="width: 33.2922%; height: 46.5938px;">Message to be shown to customer in the checkout</td></tr><tr style="height: 80.1875px;"><td style="width: 33.2922%; height: 80.1875px;">capture (optional)  
</td><td style="width: 33.2922%; height: 80.1875px;">Boolean (default: true)</td><td style="width: 33.2922%; height: 80.1875px;">If capture is set to false, a manual capture has to be done later. In order to release the funds back to the client the Refund endpoint can be used.  
</td></tr><tr><td style="width: 33.2922%;">allowSaveCard (optional)</td><td style="width: 33.2922%;">Boolean (default: true)</td><td style="width: 33.2922%;">If allowSaveCard is set to false, the user can't save the card in his card list for future usage.</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">returnUrl</td><td style="width: 33.2922%; height: 63.3906px;">String</td><td style="width: 33.2922%; height: 63.3906px;">URL where the customer should be returned to after checkout process is done.</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">returnUrlCancel</td><td style="width: 33.2922%; height: 63.3906px;">String</td><td style="width: 33.2922%; height: 63.3906px;">URL where the customer should be returned to if cancelling the checkout process</td></tr><tr style="height: 39.7969px;"><td style="width: 33.2922%; height: 39.7969px;">customer\_id (optional)</td><td style="width: 33.2922%; height: 39.7969px;">String</td><td style="width: 33.2922%; height: 39.7969px;">If present activate the possibility to save the card during the payment</td></tr><tr><td style="width: 33.2922%;">card\_id (optional)</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">If present (customer\_id required) do an automatic payment</td></tr><tr><td style="width: 33.2922%;">template (optional)  
</td><td style="width: 33.2922%;">String  
</td><td style="width: 33.2922%;">For now only can be "iframe" which removes background image  
</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2922%; height: 46.5938px;">metaData</td><td style="width: 33.2922%; height: 46.5938px;">Array</td><td style="width: 33.2922%; height: 46.5938px;">Key value pair array to store additional data together with the payment.</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-04/scaled-1680-/image.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-04/image.png)

# Retrieve [POST]

<span style="background-color: #c2e0f4;">**https://api.paiwise.com/checkout/retrieve**</span> \[POST\]

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">checkout\_id</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">The checkout\_id received when creating a checkout object</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2022-08/scaled-1680-/YTJimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2022-08/YTJimage.png)

# Capture [POST]

<span style="background-color: #c2e0f4;">**https://api.paiwise.com/checkout/capture**</span> \[POST\]

Capture is used if capture was set to false when creating a checkout object. And if status of the object is “reserved”

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">checkout\_id</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">The checkout\_id received when creating a checkout object</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2022-07/scaled-1680-/1gFimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2022-07/1gFimage.png)

# Refund [POST]

<span style="background-color: #c2e0f4;">**https://api.paiwise.com/checkout/refund**</span> \[POST\]

The refund can be used on objects that has status “paid” or “reserved” and will result in changing the status to either “refunded” or “reserve released”

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 103.58%;"><tbody><tr><td style="width: 33.3745%;">checkout\_id</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">The checkout\_id received when creating a checkout object</td></tr><tr><td style="width: 33.3745%;">amount (optional)</td><td style="width: 33.3745%;">Int</td><td style="width: 33.3745%;">If an amount to be refunded is not set the whole amount will be refunded</td></tr><tr><td style="width: 33.3745%;">reason (optional)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">Reason of the refund. Value admitted: "duplicate", "requested\_by\_customer" or "fraudolent"</td></tr><tr><td style="width: 33.3745%;">refundDetails (optional)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">Comments about the refund. Free text</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2022-10/scaled-1680-/wzKimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2022-10/wzKimage.png)

# Update [POST]

<span style="background-color: #c2e0f4;">**https://api.paiwise.com/checkout/update**</span>\[POST\]

The update can be used on objects that has every status

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 103.58%;"><tbody><tr><td style="width: 33.3745%;">checkout\_id</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">The checkout\_id received when creating a checkout object</td></tr><tr><td style="width: 33.3745%;">metaData</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">An object key-value (if value is empty, the relative key will be deleted from the object)</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-09/scaled-1680-/p31image.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-09/p31image.png)