Sign in

Get payment

get/payments/{id}

Path parameters

idstring required

The payment id to retrieve.

Headers

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-response-wait-timeinteger

Specifies the duration, in seconds, for which the HTTP call will be hanging, waiting for a payment status change. <br> <br> The maximum allowed value is 60 seconds.

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.

Response

OK

idstring

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

code_identifierstring

The Satispay code identifier. <br> <br> This string can be encoded in a QR code that can be scanned by the user. <br> This property is only available in MATCH_CODE flow payments.

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> PENDING <br> The payment is created and awaits user interaction, such as scanning the QR code. <br> <br> AUTHORIZED - for FUND_LOCK and PRE_AUTHORIZED_FUND_LOCK flows only. <br> The payment has been authorized by the user and is ready to be confirmed by the merchant with the Update payment API. <br> <br> ACCEPTED <br> The payment has been accepted and succesfully executed. <br> <br> CANCELED <br> The payment has been canceled, this could happen if: <br> - the consumer's explicitely declines it in the Satispay app. <br> - the merchant cancels it via the Update payment API with a CANCEL action. <br> - the payment reaches the expiration_date while in a PENDING or AUTHORIZED status.

status_ownershipboolean
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.

descriptionstring

The external_code set during the payment creation request. <br> <br> Please use the external_code field instead.

flowstring
external_codestring

The external_code set during the creation request.

redirect_urlstring

The URL where the user will be redirected after the payment flow from the Satispay app is completed. <br> <br> This property is available only when the payment uses the MATCH_CODE, MATCH_USER or FUND_LOCK flow.

Changes

No recorded changes to this endpoint across all 1 revision of this API.