--- title: "Get payment actions" method: GET path: "/payments/{id}/actions" tags: ["Payments"] --- # Get payment actions `GET /payments/{id}/actions` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/payments/{id}/actions` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `gateway`, `gateway:payment-details` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns all the actions associated with a payment ordered by processing date in descending order (latest first). ## Path parameters - `id` string, required ## Response `200` Payment actions retrieved successfully - union - PaymentAction[]: The payment actions - `id` string, required: The action identifier - `type` 'Authorization' | 'Card Verification' | 'Void' | 'Capture' | 'Refund' | 'Payout' | 'Return', required: The type of action - `processed_on` string, date-time, required: Read-only UTC timestamp, automatically assigned by us - `amount` integer, required: The action amount - `approved` boolean: Whether the action was successful - `auth_code` string: The issuer authorization code for cards. Only applicable for payins. - `response_code` string, required: The Gateway response code - `response_summary` string: The Gateway response summary - `authorization_type` 'Final' | 'Estimated' | 'Incremental': The authorization type. Only applicable for payins. - `reference` string: Your reference for the action. Only applicable for payins. - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of - `id` string, required: The id of the sub-entity. - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the minor currency unit. - `reference` string: A reference you can later use to identify this split, such as an order number. - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount` - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the minor currency unit. - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places. - `processing` object: Returns information related to the processing of the payment. Only applicable for payins. - `retrieval_reference_number` string: A unique identifier for the authorization that is submitted to the card scheme during processing - `acquirer_reference_number` string: A unique identifier for the capture that is submitted to the card scheme during processing - `acquirer_transaction_id` string: A unique identifier for the transaction generated by the acquirer - `capture_action_id` string: The Checkout.com action ID of the capture you wanted to refund. Required only for PayPal and Riverty. - `items` object[]: The order's line items. - `type` 'digital' | 'discount' | 'physical': The item type. For example, `physical` or `digital`. This field is used to provide item level metadata where applicable. If `source.type` is `sequra`, this field is required. - `sub_type` 'blockchain' | 'cbdc' | 'cryptocurrency' | 'nft' | 'stablecoin': The digital item type. If `type` is set to `digital`, this field is required. - `name` string: The descriptive name of the line item. If `source.type` is `sequra`, this field is required. - `quantity` integer: The number of line items. If `source.type` is `sequra`, this field is required. - `unit_price` integer: The unit price of the item the minor currency unit. Required if `source.type` is `sequra` - `reference` string: The item reference or product SKU (stock-keeping unit). For Visa and Mastercard's interchange reduction programs, this value has a maximum length of 12 characters. If `source.type` is `sequra`, this field is required. - `commodity_code` string: A code identifying a Commodity for value-added tax (VAT) purposes. - `unit_of_measure` string: Unit of Measure code used for an item in transaction. - `total_amount` number: The total cost of the line item, in minor currency units. Calculate this using the following formula: `total_amount` = (`quantity` * `unit_price`) - `discount_amount`. If `source.type` is `sequra`, this field is required. - `tax_rate` number: The tax rate of the item line in minor units. The percentage value is represented with two implicit decimals. For example, 2000=20%. - `tax_amount` number: Contains the total amount of sales tax or value-added tax (VAT) on the total purchase amount. Tax should be included in the total purchase. - `tax_exempt` boolean: Indicates whether the products or services are tax-exempt.

Set to `true` if: - You are processing a card payment. - The `tax_amount` field is `0` due to a tax-exempt product or service. - `discount_amount` number: The discount applied to each invoice line item. - `wxpay_goods_id` string: Unified product No. defined by WeChat Pay - `url` string: Link to the line item's product page - `image_url` string: Link to the line item's product page - `service_ends_on` string, date: Maximum date for the service to be rendered or ended. If `source.type` is `sequra` and `item.type` is `digital`, this field is required. - `purchase_country` string: The country where the purchase was made.
Format – ISO alpha-2 country code - `foreign_retailer_amount` integer: The foreign retailer amount the merchant applied to the transaction, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value). - `metadata` object: A set of key-value pairs that you can attach to an action. Only applicable for payins. - PaymentAction[]: The payout actions. - `id` string, required: The action identifier - `type` 'Authorization' | 'Card Verification' | 'Void' | 'Capture' | 'Refund' | 'Payout' | 'Return', required: The type of action - `processed_on` string, date-time, required: Read-only UTC timestamp, automatically assigned by us - `amount` integer, required: The action amount - `approved` boolean: Whether the action was successful - `auth_code` string: The issuer authorization code for cards. Only applicable for payins. - `response_code` string, required: The Gateway response code - `response_summary` string: The Gateway response summary - `authorization_type` 'Final' | 'Estimated' | 'Incremental': The authorization type. Only applicable for payins. - `reference` string: Your reference for the action. Only applicable for payins. - `amount_allocations` object[]: The sub-entities that the payment is being processed on behalf of - `id` string, required: The id of the sub-entity. - `amount` integer, required: The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount. The amount must be provided in the minor currency unit. - `reference` string: A reference you can later use to identify this split, such as an order number. - `commission` object: Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount. Commission = (`amount` * `commission.percentage`) + `commission.amount` - `amount` integer: Optional fixed amount of commission to collect. The amount must be provided in the minor currency unit. - `percentage` number: Optional percentage of commission to collect. Supports up to 8 decimal places. - `processing` object: Returns information related to the processing of the payment. Only applicable for payins. - `retrieval_reference_number` string: A unique identifier for the authorization that is submitted to the card scheme during processing - `acquirer_reference_number` string: A unique identifier for the capture that is submitted to the card scheme during processing - `acquirer_transaction_id` string: A unique identifier for the transaction generated by the acquirer - `capture_action_id` string: The Checkout.com action ID of the capture you wanted to refund. Required only for PayPal and Riverty. - `items` object[]: The order's line items. - `type` 'digital' | 'discount' | 'physical': The item type. For example, `physical` or `digital`. This field is used to provide item level metadata where applicable. If `source.type` is `sequra`, this field is required. - `sub_type` 'blockchain' | 'cbdc' | 'cryptocurrency' | 'nft' | 'stablecoin': The digital item type. If `type` is set to `digital`, this field is required. - `name` string: The descriptive name of the line item. If `source.type` is `sequra`, this field is required. - `quantity` integer: The number of line items. If `source.type` is `sequra`, this field is required. - `unit_price` integer: The unit price of the item the minor currency unit. Required if `source.type` is `sequra` - `reference` string: The item reference or product SKU (stock-keeping unit). For Visa and Mastercard's interchange reduction programs, this value has a maximum length of 12 characters. If `source.type` is `sequra`, this field is required. - `commodity_code` string: A code identifying a Commodity for value-added tax (VAT) purposes. - `unit_of_measure` string: Unit of Measure code used for an item in transaction. - `total_amount` number: The total cost of the line item, in minor currency units. Calculate this using the following formula: `total_amount` = (`quantity` * `unit_price`) - `discount_amount`. If `source.type` is `sequra`, this field is required. - `tax_rate` number: The tax rate of the item line in minor units. The percentage value is represented with two implicit decimals. For example, 2000=20%. - `tax_amount` number: Contains the total amount of sales tax or value-added tax (VAT) on the total purchase amount. Tax should be included in the total purchase. - `tax_exempt` boolean: Indicates whether the products or services are tax-exempt.

Set to `true` if: - You are processing a card payment. - The `tax_amount` field is `0` due to a tax-exempt product or service. - `discount_amount` number: The discount applied to each invoice line item. - `wxpay_goods_id` string: Unified product No. defined by WeChat Pay - `url` string: Link to the line item's product page - `image_url` string: Link to the line item's product page - `service_ends_on` string, date: Maximum date for the service to be rendered or ended. If `source.type` is `sequra` and `item.type` is `digital`, this field is required. - `purchase_country` string: The country where the purchase was made.
Format – ISO alpha-2 country code - `foreign_retailer_amount` integer: The foreign retailer amount the merchant applied to the transaction, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value). - `metadata` object: A set of key-value pairs that you can attach to an action. Only applicable for payins. ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Payment not found - `429`: Too Many Requests --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)