Neuro-Pay Checkout API

outlining the functionality and implementaiton of the paiwise checkout API

• Authentification
• Data format
• Requests
• Create [POST]
• Retrieve [POST]
• Capture [POST]
• Refund [POST]
• Update [POST]
• Response
• The response object
• Customer's Request
• Create customer [POST]
• Retrieve customer [POST]
• Delete customer [POST]
• Customer's Response
• The response object
• Postman collection

Authentification

In order to use the checkout API the company in question needs to generate an API key through the Neuro-Admin platform. Said API key should be sent as a bearer token in each request.

Data format

The API currently accepts and returns JSON data in the body

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)

Response

The response object

For each endpoint the checkout object will be returned in its “new state”
Example:

Possible statuses are

• created
• reserved
• reserve released
• paid
• refunded
• partialRefund
• revoked
• failed
• canceled

 

Every date and time returned are in UTC.

Customer's Request

Create customer [POST]

https://api.paiwise.com/checkout/create-customer [POST]

first_name	String	Customer's last name
last_name	String	Customer's last name
email	String	Customer's email
metaData	Array	Key value pair array to store additional data together with the customer.

Retrieve customer [POST]

https://api.paiwise.com/checkout/retrieve-customer [POST]

customer_id

String

Customer's id

Delete customer [POST]

https://api.paiwise.com/checkout/delete-customer [POST]

customer_id

String

Customer's id

Customer's Response

The response object

For each endpoint the customer object will be returned
Example:

The customer object also returns a "Client_page", following this link the customer can change the card configuration by adding/deleting and set the default a card for a future payment.

Postman collection

attached to this page is a postman collection for testing

All requests inherits the authentication from the collection. as the bearer token you add your API key test or live,

You can find file attachments in top left corner of this page