Requests
Collection of possible requests
Create [POST]
https://api.paiwise.com/checkout/create [POST]
| identifier (optional) | String | Identifier of the checkout, if not passed the cid will get as reference |
| amount | int | Smallest nominee for the currency. Example: 30SEK is 3000 öre so value of this param should be 3000 |
| currency | String | EUR, SEK, USD… etc |
| message | String | Message to be shown to customer in the checkout |
| capture (optional) |
Boolean (default: true) | 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. |
| allowSaveCard (optional) | Boolean (default: true) | If allowSaveCard is set to false, the user can't save the card in his card list for future usage. |
| returnUrl | String | URL where the customer should be returned to after checkout process is done. |
| returnUrlCancel | String | URL where the customer should be returned to if cancelling the checkout process |
| customer_id (optional) | String | If present activate the possibility to save the card during the payment |
| card_id (optional) | String | If present (customer_id required) do an automatic payment |
| template (optional) |
String |
For now only can be "iframe" which removes background image |
| metaData | Array | Key value pair array to store additional data together with the payment. |
Retrieve [POST]
https://api.paiwise.com/checkout/retrieve [POST]
Values
| checkout_id | String | The checkout_id received when creating a checkout object |
Capture [POST]
https://api.paiwise.com/checkout/capture [POST]
Capture is used if capture was set to false when creating a checkout object. And if status of the object is “reserved”
Values
| checkout_id | String | The checkout_id received when creating a checkout object |
Refund [POST]
https://api.paiwise.com/checkout/refund [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
| checkout_id | String | The checkout_id received when creating a checkout object |
| amount (optional) | Int | If an amount to be refunded is not set the whole amount will be refunded |
| reason (optional) | String | Reason of the refund. Value admitted: "duplicate", "requested_by_customer" or "fraudolent" |
| refundDetails (optional) | String | Comments about the refund. Free text |
Update [POST]
https://api.paiwise.com/checkout/update[POST]
The update can be used on objects that has every status
Values
| checkout_id | String | The checkout_id received when creating a checkout object |
| metaData | String | An object key-value (if value is empty, the relative key will be deleted from the object) |
