Update payment

put

https://authservices.satispay.com/g_business/v1/payments/{id}

Path Params

string

required

The payment id to update.

Body Params

action

string

enum

required

The action to execute on a specific payment.

ACCEPT
This action can be used to accept PENDING or AUTHORIZED payments.

CANCEL
This action can be used to cancel PENDING or AUTHORIZED payments.

CANCEL_OR_REFUND
This action can be used to cancel PENDING or AUTHORIZED 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:

amount_unit

integer

The payment amount that you want to capture in cents.

To represent the amount €12.40, you should multiply it by 100, resulting in 1240 cents.

This property is applicable only for payments in AUTHORIZED status.
These payments must be created using either the FUND_LOCK or PRE_AUTHORIZED_FUND_LOCK flow.

This amount must be equal or smaller than the amount set during the payment creation.

Headers

Content-Type

string

required

Always send this header as application/json.

Host

string

required

The host declared in the signature.

Date

string

required

The date declared in the signature.

Digest

string

required

The digest declared in the signature.

Authorization

string

required

The request signature.

x-satispay-deviceinfo

string

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

x-satispay-devicetype

string

enum

The device type.

Allowed:

x-satispay-os

string

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

x-satispay-osv

string

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

x-satispay-apph

string

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

x-satispay-appn

string

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

x-satispay-appv

string

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

x-satispay-tracking-code

string

The tracking code used by Satispay commercial partners.

Use this code only if explicitly required by Satispay.

Responses

200OK

400400 Bad Request

401401 Unauthorized

403403 Forbidden or invalid authorization header

404404 Resource not found