API Documentation

Update payment

put
https://authservices.satispay.com/g_business/v1/payments/

The following guide explains how to accept payments using Satispay Fringe Benefits.

In this page, you can find the specific request parameters that you can use for Fringe Benefits payments.
To read the generic API specification please refer to this page.

Payment update

While accepting a payment, if your shop has Fringe Benefits enabled, Fringe Benefits will be used based on the user's Fringe Benefits availability.
These Fringe Benefits will be applied if the user sets the Fringe Benefits wallet as their primary wallet.

It is not possible to have a combination of Fringe Benefits and Meal Vouchers in the same payment, since these two payment methods are mutually exclusive.

🚧

Check-in integration

When you're integrating the check-in flow, be sure to always show all the available PENDING payments.

You can use this API to perform an update action on a specific payment.

The actions that you can perform are:

ACCEPT

You can use this action to accept payments sent via check-in in PENDING status.

CANCEL

You can use this action to cancel payments sent via check-in in PENDING status.

CANCEL_OR_REFUND ⚠️

We strongly suggest you to use this action only if you are not able to retrieve the actual payment status.
This could be due to either temporary unavailability of Satispay or network issues.

By executing the CANCEL_OR_REFUND action, we prevent situations where a user confirms a payment, the payment is accepted, but the product is not issued to the user.

What this action will do is:

  • refund the payment if it is in an ACCEPTED status.
  • cancel the payment if it is in a PENDING status.

The response will also change accordingly, please check our response examples.

🚧

RETRY

If the API returns an error, such as a 500, it does not necessarily mean that the payment has not already been accepted.

If you encounter this error, we suggest retrying the request within a few seconds.
If you still do not receive a response, execute an Update Payment using the CANCEL_OR_REFUND action.

📘

CANCEL vs REFUND payments

A payment can only transition to CANCELED status if it has not yet reached the ACCEPTED status.
Once a payment reaches ACCEPTED, it can no longer be canceled.

If an ACCEPTED payment needs to be refunded you need to create a payment with a REFUND flow.

REQUEST


Path Params
string
required

The payment id to update.

Body Params
string
enum
required

The action to execute on a specific payment.

ACCEPT
This action can be used to accept PENDING payments.

CANCEL
This action can be used to cancel PENDING payments.

CANCEL_OR_REFUND
This action can be used to cancel PENDING payments.
Or to refund a payment in status ACCEPTED.

We suggest to execute this action only if you don't know the actual status of the payment.
For example if you received a timeout or an HTTP 500.

Depending on the actual status of the payment, you will receive a different outcome and response.

Allowed:
Headers
string
required

The host declared in the signature.

string
required

The date declared in the signature.

string
required

The digest declared in the signature.

string
required

The request signature.

string

The device information (e.g., hostname).

string
enum

The device type.

Allowed:
string

The Operating System name (e.g., Windows).

string

The Operating System version (e.g., 10).

string

The software house name (e.g., Satispay).

string

The software name (e.g., My awesome app).

string

The software version (e.g., v2.0.0).

string

The tracking code used by Satispay commercial partners.

Use this code only if explicitly required by Satispay.

Responses

Updated 3 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago