v1

latestOpenAPI 3.1.02026-07-24130244.8 KB

Update payment

put/payments/{id}

Path parameters

idstring required

The payment id to update.

Headers

Content-Typestring required

Always send this header as application/json.

Hoststring required

The host declared in the signature.

Datestring required

The date declared in the signature.

Digeststring required

The digest declared in the signature.

Authorizationstring required

The request signature.

x-satispay-deviceinfostring

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

x-satispay-devicetype'SMARTPHONE' | 'TABLET' | 'CASH REGISTER' | 'POS' | 'PC' | 'ECOMMERCE_PLUGIN'

The device type.

x-satispay-osstring

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

x-satispay-osvstring

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

x-satispay-apphstring

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

x-satispay-appnstring

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

x-satispay-appvstring

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

x-satispay-tracking-codestring

The tracking code used by Satispay commercial partners. <br> <br> Use this code only if explicitly required by Satispay.

Request body

action'ACCEPT' | 'CANCEL' | 'CANCEL_OR_REFUND' required

The action to execute on a specific payment. <br> <br> ACCEPT <br> This action can be used to accept PENDING or AUTHORIZED payments. <br> <br> CANCEL <br> This action can be used to cancel PENDING or AUTHORIZED payments. <br> <br> CANCEL_OR_REFUND <br> This action can be used to cancel PENDING or AUTHORIZED payments. <br> Or to refund a payment in status ACCEPTED. <br> <br> We suggest to execute this action only if you don't know the actual status of the payment. <br> For example if you received a timeout or an HTTP 500. <br> <br> Depending on the actual status of the payment, you will receive a different outcome and response.

amount_unitinteger

The payment amount that you want to capture in cents. <br> <br> To represent the amount €12.40, you should multiply it by 100, resulting in 1240 cents. <br> <br> This property is applicable only for payments in AUTHORIZED status. <br> These payments must be created using either the FUND_LOCK or PRE_AUTHORIZED_FUND_LOCK flow. <br> <br> This amount must be equal or smaller than the amount set during the payment creation.

Response

OK

idstring

The unique payment id. <br> <br> This can be used for every eventual subsequent operations on the payment, including refunds.

typestring

The current payment type. <br> <br> TO_BUSINESS <br> This type is used for payments from a consumer to a merchant. <br> <br> REFUND_TO_BUSINESS <br> This type is used for payments from a merchant to a consumer (e.g. refunds).

amount_unitinteger

The payment amount in cents. <br> <br> For example, the amount €12.40 is being represented as 1240 cents.

currency'EUR'

The payment currency.

statusstring

The current payment status. <br> <br> ACCEPTED <br> The payment has been accepted succesfully. <br> Beware: if you use the CANCEL_OR_REFUND action and you receive back an ACCEPTED status, this means that the payment has been successfully refunded. <br> <br> CANCELED <br> The payment has been correctly canceled. <br> Beware: if you use the CANCEL_OR_REFUND action and you receive back a CANCELED status, this means that the payment has been successfully canceled.

expiredboolean

The current payment expiration status. <br> <br> It becomes true once it reaches the expiration_date without being accepted or canceled.

metadataobject

The additional metadata for the payment.

insert_datestring

The UTC payment creation datetime.

expire_datestring

The UTC payment expiration datetime.