TransactionResponse

data
required

A payin, refund or payout. The type is in object.
A payin, refund or payout. The type is in object.
Fields every transaction has — payin, refund and payout. object and method_type tell which fields come on top; the fields of the payment instrument are in an object named after it — card, apple_pay or google_pay.

object
Discriminator
const:
payin
required
amount
Type:
required
Properties: 2
created_at
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

id
Type: stringFormat: uuid
required

Transaction id. The type of the transaction is in object.

merchant_reference
Type:
min length:
1
max length:
100
required

Your id for the transaction, unique per merchant across payins, refunds, payouts and pay sessions. It is also the idempotency key of the create — the same reference with the same body returns the existing transaction, with a different body 409 merchant_reference_conflict. Never expires.

method_type
Type: enum
required
values
payin_cardpayin_apple_paypayin_google_paypayin_blik
refunded_amount
Type:
required
Properties: 2
status
Type: enum
required
values
created

Recorded, processing not started. Not final.

processing

Checks or provider in progress. Not final.

requires_action

The payer has a step to take — read next_action. Not final.

authorized

Amount on hold (card, two-step). Call capture or void. Not final.

completed

Charged. Final; the only change after it is refunded.

failed

Not charged — read status_details.code. Covers declines, a voided hold (canceled_by_merchant), a payer who rejected (canceled_by_payer). Final.

refunded

Charged, then refunded in part or in full — read refunded_amount. Set by the first completed refund and kept by later ones. Final.

status_details
Type: nullable
required

Why the transaction ended failed. null in every other status.

Properties: 2
updated_at
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

apple_pay
Type: object

Set only when method_type is payin_apple_pay, after the token is decrypted.

Properties: 2
capture_method
Type: "automatic" or "manual"enum

Set only when method_type is payin_card. manual — the shop holds card payins at authorized until capture or void.

card
Type: object

Set only when method_type is payin_card.

Properties: 3
google_pay
Type: object

Set only when method_type is payin_google_pay, after the token is decrypted.

Properties: 2
next_action
Type: nullable

What the payer has to do while the payin is requires_action. Guide — /v2/guides/common/payer-actions.

Properties: 3

PayoutResponse

ApplePaySessionResponse