Skip to content
SumUpSumUp Developer

Transactions

SumUp API reference and code samples.

Transactions represent completed or attempted payment operations processed for a merchant account. A transaction contains the core payment result, such as the amount, currency, payment method, creation time, and current high-level status.

In addition to the main payment outcome, a transaction can contain related events that describe what happened after the original payment attempt. These events provide visibility into the financial lifecycle of the transaction, for example:

  • PAYOUT: the payment being prepared for payout or included in a payout to the merchant
  • REFUND: money returned to the payer
  • CHARGE_BACK: money reversed after the original payment
  • PAYOUT_DEDUCTION: an amount deducted from a payout to cover a refund or chargeback

From an integrator's perspective, transactions are the authoritative record of payment outcomes. Use this tag to:

  • list transactions for reporting, reconciliation, and customer support workflows
  • retrieve a single transaction when you need the latest payment details
  • inspect simple_status for the current merchant-facing outcome of the payment
  • inspect events or transaction_events when you need refund, payout, or chargeback history

Typical workflow:

  • create and process payments through the Checkouts endpoints
  • use the Transactions endpoints to read the resulting payment records
  • use the returned statuses and events to update your own order, accounting, or support systems
Transactions

Retrieve a transaction

GET/v2.1/merchants/{merchant_code}/transactions

Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and one of following parameters is required:

  • id
  • transaction_code
  • foreign_transaction_id
  • client_transaction_id
Required scopes:transactions.history

Path Parameters

  • merchant_codestringrequired

    Merchant code of the account whose transaction should be retrieved.

    Example: "MH4H92C7"

Query Parameters

  • idstring

    Retrieves the transaction resource with the specified transaction ID (the id parameter in the transaction resource).

  • transaction_codestring

    Retrieves the transaction resource with the specified transaction code.

  • foreign_transaction_idstring

    External/foreign transaction id (passed by clients).

  • client_transaction_idstring

    Client transaction id.

Response

Returns the requested transaction resource.

  • idstring

    Unique ID of the transaction.

    Example: "6b425463-3e1b-431d-83fa-1e51c2925e99"
  • transaction_codestring

    Transaction code returned by the acquirer/processing entity after processing the transaction.

    Example: "TEENSK4W2K"
  • amountnumber

    Total amount of the transaction.

    Example: 10.1
  • currencyCurrency
    Options: BGNBRLCHFCLPCOPCZKDKKEURGBPHRKHUFNOKPLNRONSEKUSD

    Three-letter ISO4217 code of the currency for the amount. Currently supported currency values are enumerated above.

    Example: "EUR"
  • timestampstringformat: date-time

    Date and time of the creation of the transaction. Response format expressed according to ISO8601 code.

    Example: "2020-02-29T10:56:56.876Z"
  • statusTransaction Status
    Options: SUCCESSFULCANCELLEDFAILEDPENDINGREFUNDED

    Current status of the transaction.

    • PENDING: The transaction has been created but its final outcome is not known yet.
    • SUCCESSFUL: The transaction completed successfully.
    • CANCELLED: The transaction was cancelled or otherwise reversed before completion.
    • FAILED: The transaction attempt did not complete successfully.
    • REFUNDED: The transaction was refunded in full or in part.
  • payment_typePayment Type
    Options: CASHPOSECOMRECURRINGBITCOINBALANCEMOTOBOLETODIRECT_DEBITAPMUNKNOWN

    Payment type used for the transaction.

  • installments_countintegerminimum: 1

    Current number of the installment for deferred payments.

  • merchant_codestring

    Unique code of the registered merchant to whom the payment is made.

    Example: "MH4H92C7"
  • vat_amountnumber

    Amount of the applicable VAT (out of the total transaction amount).

    Example: 6
  • tip_amountnumber

    Amount of the tip (out of the total transaction amount).

    Example: 3
  • entry_modeEntry Mode
    Options: BOLETOSOFORTIDEALBANCONTACTEPSMYBANKSATISPAYBLIKP24GIROPAYPIXQR_CODE_PIXAPPLE_PAYGOOGLE_PAYPAYPALTWINTNONECHIPMANUAL_ENTRYCUSTOMER_ENTRYMAGSTRIPE_FALLBACKMAGSTRIPEDIRECT_DEBITCONTACTLESSMOTOCONTACTLESS_MAGSTRIPEN/A

    Entry mode of the payment details.

  • auth_codestring

    Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.

    Example: "053201"
  • product_summarystring

    Short description of the payment. The value is taken from the description property of the related checkout resource.

  • payouts_totalinteger

    Total number of payouts to the registered user specified in the user property.

  • payouts_receivedinteger

    Number of payouts that are made to the registered user specified in the user property.

  • payout_planstring
    Options: SINGLE_PAYMENTTRUE_INSTALLMENTACCELERATED_INSTALLMENT

    Payout plan of the registered user at the time when the transaction was made.

  • foreign_transaction_idstring

    External/foreign transaction id (passed by clients).

    Example: "J13253253x1"
  • client_transaction_idstring

    Client transaction id.

    Example: "urn:sumup:pos:sale:MNKKNGST:1D4E3B2D-111D-48D7-9AF0-832DAEF63DD7;2"
  • usernamestringformat: email

    Email address of the registered user (merchant) to whom the payment is made.

  • fee_amountnumber

    Transaction SumUp total fee amount.

    Example: 8
  • latLatitudeminimum: 0, maximum: 90

    Latitude value from the coordinates of the payment location (as received from the payment terminal reader).

  • lonLongitudeminimum: 0, maximum: 180

    Longitude value from the coordinates of the payment location (as received from the payment terminal reader).

  • horizontal_accuracyHorizontal Accuracy

    Indication of the precision of the geographical position received from the payment terminal.

  • merchant_idinteger

    SumUp merchant internal Id.

    Example: 136902
  • device_infoDevice

    Details of the device used to create the transaction.

     Show attributes
     Close
    Device
    • namestring

      Device name.

      Example: "m0xx"
    • system_namestring

      Device OS.

      Example: "Android"
    • modelstring

      Device model.

      Example: "GT-I9300"
    • system_versionstring

      Device OS version.

      Example: "4.3"
    • uuidstring

      Device UUID.

      Example: "3ae2a6b7-fb0d-3b50-adbf-cb7e2db30cd2"
  • simple_payment_typestring
    Options: CASHCC_SIGNATUREELVELV_WITHOUT_SIGNATURECC_CUSTOMER_ENTEREDMANUAL_ENTRYEMVRECURRINGBALANCEMOTOBOLETOAPMBITCOINCARD

    Simple name of the payment type.

  • verification_methodstring
    Options: nonesignatureoffline PINonline PINoffline PIN + signaturena

    Verification method used for the transaction.

  • cardCard Response

    Details of the payment card.

     Show attributes
     Close
    Card Response
    • last_4_digitsstringmin length: 4, max length: 4, Read only

      Last 4 digits of the payment card number.

      Example: "3456"
    • typeCard Type
      Options: ALELOAMEXCONECSCUPDINERSDISCOVEREFTPOSELOELVGIROCARDHIPERCARDINTERACJCBMAESTROMASTERCARDPLUXEESWILETICKETVISAVISA_ELECTRONVISA_VPAYVPAYVRUNKNOWN

      Issuing card network of the payment card used for the transaction.

  • elv_accountELV Card Account

    Details of the ELV card account associated with the transaction.

     Show attributes
     Close
    ELV Card Account
    • sort_codestring

      ELV card sort code.

      Example: "87096214"
    • last_4_digitsstring

      ELV card account number last 4 digits.

      Example: "5674"
    • sequence_nointeger

      ELV card sequence number.

      Example: 1
    • ibanstring

      ELV IBAN.

      Example: "DE60870962140012345674"
  • local_timestringformat: date-time

    Local date and time of the creation of the transaction.

  • payout_datestringformat: date

    The date of the payout.

    Example: "2019-08-28"
  • payout_typestring
    Options: BANK_ACCOUNTPREPAID_CARD

    Payout type for the transaction.

  • process_asstring
    Options: CREDITDEBIT

    Debit/Credit.

    Example: "CREDIT"
  • products[]Product

    List of products from the merchant's catalogue for which the transaction serves as a payment.

     Show attributes
     Close
    Product
    • namestring

      Product name.

      Example: "Purchase reader for merchant with code ME3FCAVF"
    • price_labelstring

      Product description.

    • pricenumber

      Product price.

      Example: 100
    • vat_ratenumber

      VAT percentage.

    • single_vat_amountnumber

      VAT amount for a single product.

    • price_with_vatnumber

      Product price incl. VAT.

    • vat_amountnumber

      VAT amount.

    • quantityinteger

      Product quantity.

      Example: 1
    • total_pricenumber

      Quantity x product price.

      Example: 100
    • total_with_vatnumber

      Total price incl. VAT.

  • vat_rates[]object

    List of VAT rates applicable to the transaction.

     Show attributes
     Close
    Attributes
    • ratenumber

      VAT rate.

      Example: 0.045
    • netnumber

      NET amount of products having this VAT rate applied.

      Example: 1.36
    • vatnumber

      VAT amount of this rate applied.

      Example: 0.06
    • grossnumber

      Gross amount of products having this VAT rate applied.

      Example: 1.42
  • transaction_events[]TransactionEvent

    Detailed list of events related to the transaction.

     Show attributes
     Close
    Transaction Event
    • idEvent ID

      Unique ID of the transaction event.

    • event_typeEvent Type
      Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION

      Type of the transaction event.

    • statusEvent Status
      Options: FAILEDPAID_OUTPENDINGRECONCILEDREFUNDEDSCHEDULEDSUCCESSFUL

      Status of the transaction event.

      Not every value is used for every event type.

      • PENDING: The event has been created but is not final yet. Used for events that are still being processed and whose final outcome is not known yet.
      • SCHEDULED: The event is planned for a future payout cycle but has not been executed yet. This applies to payout events before money is actually sent out.
      • RECONCILED: The underlying payment has been matched with settlement data and is ready to continue through payout processing, but the funds have not been paid out yet. This applies to payout events.
      • PAID_OUT: The payout event has been completed and the funds were included in a merchant payout.
      • REFUNDED: A refund event has been accepted and recorded in the refund flow. This is the status returned for refund events once the transaction amount is being or has been returned to the payer.
      • SUCCESSFUL: The event completed successfully. Use this as the generic terminal success status for event types that do not expose a more specific business outcome such as PAID_OUT or REFUNDED.
      • FAILED: The event could not be completed. Typical examples are a payout that could not be executed or an event that was rejected during processing.
    • amountnumber

      Amount of the event.

      Example: 58.8
    • due_datestringformat: date

      Date when the transaction event is due to occur.

      Example: "2020-05-25"
    • datestringformat: date

      Date when the transaction event occurred.

      Example: "2020-05-25"
    • installment_numberinteger

      Consecutive number of the installment that is paid. Applicable only payout events, i.e. event_type = PAYOUT.

      Example: 1
    • timestampstringformat: date-time

      Date and time of the transaction event.

      Example: "2020-05-25T10:49:42.784Z"
  • simple_statusstring
    Options: SUCCESSFULPAID_OUTCANCEL_FAILEDCANCELLEDCHARGEBACKFAILEDREFUND_FAILEDREFUNDEDNON_COLLECTIONPENDING

    High-level status of the transaction from the merchant's perspective.

    • PENDING: The payment has been initiated and is still being processed. A final outcome is not available yet.
    • SUCCESSFUL: The payment was completed successfully.
    • PAID_OUT: The payment was completed successfully and the funds have already been included in a payout to the merchant.
    • FAILED: The payment did not complete successfully.
    • CANCELLED: The payment was cancelled or reversed and is no longer payable or payable to the merchant.
    • CANCEL_FAILED: An attempt to cancel or reverse the payment was not completed successfully.
    • REFUNDED: The payment was refunded in full or in part.
    • REFUND_FAILED: An attempt to refund the payment was not completed successfully.
    • CHARGEBACK: The payment was subject to a chargeback.
    • NON_COLLECTION: The amount could not be collected from the merchant after a chargeback or related adjustment.
  • links[]Link

    List of hyperlinks for accessing related resources.

     Show attributes
     Close
    Link
    • relstring

      Specifies the relation to the current resource.

    • hrefstringformat: uri

      URL for accessing the related resource.

    • typestring

      Specifies the media type of the related resource.

    • min_amountnumber

      Minimum allowed amount for the refund.

    • max_amountnumber

      Maximum allowed amount for the refund.

  • events[]Event

    Compact list of events related to the transaction.

     Show attributes
     Close
    Event
    • idEvent ID

      Unique ID of the transaction event.

    • transaction_idTransaction ID

      Unique ID of the transaction.

    • typeEvent Type
      Options: PAYOUTCHARGE_BACKREFUNDPAYOUT_DEDUCTION

      Type of the transaction event.

    • statusEvent Status
      Options: FAILEDPAID_OUTPENDINGRECONCILEDREFUNDEDSCHEDULEDSUCCESSFUL

      Status of the transaction event.

      Not every value is used for every event type.

      • PENDING: The event has been created but is not final yet. Used for events that are still being processed and whose final outcome is not known yet.
      • SCHEDULED: The event is planned for a future payout cycle but has not been executed yet. This applies to payout events before money is actually sent out.
      • RECONCILED: The underlying payment has been matched with settlement data and is ready to continue through payout processing, but the funds have not been paid out yet. This applies to payout events.
      • PAID_OUT: The payout event has been completed and the funds were included in a merchant payout.
      • REFUNDED: A refund event has been accepted and recorded in the refund flow. This is the status returned for refund events once the transaction amount is being or has been returned to the payer.
      • SUCCESSFUL: The event completed successfully. Use this as the generic terminal success status for event types that do not expose a more specific business outcome such as PAID_OUT or REFUNDED.
      • FAILED: The event could not be completed. Typical examples are a payout that could not be executed or an event that was rejected during processing.
    • amountnumber

      Amount of the event.

    • timestampstringformat: date-time

      Date and time of the transaction event.

    • fee_amountnumber

      Amount of the fee related to the event.

    • installment_numberinteger

      Consecutive number of the installment.

    • deducted_amountnumber

      Amount deducted for the event.

    • deducted_fee_amountnumber

      Amount of the fee deducted for the event.

  • locationobject

    Details of the payment location as received from the payment terminal.

     Show attributes
     Close
    Attributes
    • latLatitudeminimum: 0, maximum: 90

      Latitude value from the coordinates of the payment location (as received from the payment terminal reader).

    • lonLongitudeminimum: 0, maximum: 180

      Longitude value from the coordinates of the payment location (as received from the payment terminal reader).

    • horizontal_accuracyHorizontal Accuracy

      Indication of the precision of the geographical position received from the payment terminal.

  • tax_enabledboolean

    Indicates whether tax deduction is enabled for the transaction.

GET/v2.1/merchants/{merchant_code}/transactions
curl https://api.sumup.com/v2.1/merchants/{merchant_code}/transactions \
 -X GET \
 -H "Authorization: Bearer $SUMUP_API_KEY"
import SumUp from '@sumup/sdk';


const client = new SumUp();


const result = await client.transactions.get("MH4H92C7");
using SumUp;


var client = new SumUpClient();


var result = await client.Transactions.GetAsync(
    "MH4H92C7"
);
import com.sumup.sdk.SumUpClient;


SumUpClient client = SumUpClient.builder().build();


var result = client.transactions().getTransactionV2_1(
  "MH4H92C7"
);
from sumup import Sumup


client = Sumup()


result = client.transactions.get("MH4H92C7")
$sumup = new \SumUp\SumUp();


$result = $sumup->transactions->get('MH4H92C7');
client := sumup.NewClient()


result, err := client.Transactions.Get(context.Background(), "MH4H92C7")
use sumup::Client;


let client = Client::default();


let result = client.transactions().get("MH4H92C7", sumup::GetTransactionV2_1Params{
    id: Some("id".to_string()),
    transaction_code: Some("transaction_code".to_string()),
    foreign_transaction_id: Some("foreign_transaction_id".to_string()),
    client_transaction_id: Some("client_transaction_id".to_string()),
}).await;
Response
{
  "id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
  "transaction_code": "TEENSK4W2K",
  "amount": 10.1,
  "currency": "EUR",
  "timestamp": "2020-02-29T10:56:56.876Z",
  "status": "SUCCESSFUL",
  "payment_type": "ECOM",
  "installments_count": 1,
  "merchant_code": "MH4H92C7",
  "vat_amount": 6,
  "tip_amount": 3,
  "entry_mode": "CUSTOMER_ENTRY",
  "auth_code": "053201"
}

Content-Type: application/json

The request is not authorized.

  • typestringrequiredformat: uri

    A URI reference that identifies the problem type.

    Example: "https://developer.sumup.com/problem/not-found"
  • titlestring

    A short, human-readable summary of the problem type.

    Example: "Requested resource couldn't be found."
  • statusinteger

    The HTTP status code generated by the origin server for this occurrence of the problem.

    Example: 404
  • detailstring

    A human-readable explanation specific to this occurrence of the problem.

    Example: "The requested resource doesn't exist or does not belong to you."
  • instancestringformat: uri

    A URI reference that identifies the specific occurrence of the problem.

Error 401
{
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
Transactions

List transactions

GET/v2.1/merchants/{merchant_code}/transactions/history

Lists detailed history of all transactions associated with the merchant profile.

Required scopes:transactions.history

Path Parameters

  • merchant_codestringrequired

    Merchant code of the account whose transaction history should be listed.

    Example: "MH4H92C7"

Query Parameters

  • transaction_codestring

    Retrieves the transaction resource with the specified transaction code.

  • orderstringdefault: ascending
    Options: ascendingdescending

    Specifies the order in which the returned results are displayed.

  • limitinteger

    Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.

  • users[][]string

    Filters the returned results by user email.

    Example: ["merchant@example.com"]
  • statuses[][]string
    Options: SUCCESSFULCANCELLEDFAILEDREFUNDEDCHARGE_BACK

    Filters the returned results by the specified list of final statuses of the transactions.

  • payment_types[][]PaymentType
    Options: CASHPOSECOMRECURRINGBITCOINBALANCEMOTOBOLETODIRECT_DEBITAPMUNKNOWN

    Filters the returned results by the specified list of payment types used for the transactions.

  • entry_modes[][]EntryMode
    Options: BOLETOSOFORTIDEALBANCONTACTEPSMYBANKSATISPAYBLIKP24GIROPAYPIXQR_CODE_PIXAPPLE_PAYGOOGLE_PAYPAYPALTWINTNONECHIPMANUAL_ENTRYCUSTOMER_ENTRYMAGSTRIPE_FALLBACKMAGSTRIPEDIRECT_DEBITCONTACTLESSMOTOCONTACTLESS_MAGSTRIPEN/A

    Filters the returned results by the specified list of entry modes.

  • types[][]string
    Options: PAYMENTREFUNDCHARGE_BACK

    Filters the returned results by the specified list of transaction types.

  • changes_sincestringformat: date-time

    Filters the results by the latest modification time of resources and returns only transactions that are modified at or after the specified timestamp (in ISO8601 format).

  • newest_timestringformat: date-time

    Filters the results by the creation time of resources and returns only transactions that are created before the specified timestamp (in ISO8601 format).

  • newest_refstring

    Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are smaller than the specified value. This parameters supersedes the newest_time parameter (if both are provided in the request).

  • oldest_timestringformat: date-time

    Filters the results by the creation time of resources and returns only transactions that are created at or after the specified timestamp (in ISO8601 format).

  • oldest_refstring

    Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are greater than the specified value. This parameters supersedes the oldest_time parameter (if both are provided in the request).

Response

Returns a page of transaction history items.

  • items[]TransactionHistory

    Transaction entry returned in history listing responses.

     Show attributes
     Close
    Transaction History
    • idstring

      Unique ID of the transaction.

      Example: "6b425463-3e1b-431d-83fa-1e51c2925e99"
    • transaction_codestring

      Transaction code returned by the acquirer/processing entity after processing the transaction.

      Example: "TEENSK4W2K"
    • amountnumber

      Total amount of the transaction.

      Example: 10.1
    • currencyCurrency
      Options: BGNBRLCHFCLPCOPCZKDKKEURGBPHRKHUFNOKPLNRONSEKUSD

      Three-letter ISO4217 code of the currency for the amount. Currently supported currency values are enumerated above.

      Example: "EUR"
    • timestampstringformat: date-time

      Date and time of the creation of the transaction. Response format expressed according to ISO8601 code.

      Example: "2020-02-29T10:56:56.876Z"
    • statusTransaction Status
      Options: SUCCESSFULCANCELLEDFAILEDPENDINGREFUNDED

      Current status of the transaction.

      • PENDING: The transaction has been created but its final outcome is not known yet.
      • SUCCESSFUL: The transaction completed successfully.
      • CANCELLED: The transaction was cancelled or otherwise reversed before completion.
      • FAILED: The transaction attempt did not complete successfully.
      • REFUNDED: The transaction was refunded in full or in part.
    • payment_typePayment Type
      Options: CASHPOSECOMRECURRINGBITCOINBALANCEMOTOBOLETODIRECT_DEBITAPMUNKNOWN

      Payment type used for the transaction.

    • installments_countintegerminimum: 1

      Current number of the installment for deferred payments.

    • product_summarystring

      Short description of the payment. The value is taken from the description property of the related checkout resource.

    • payouts_totalinteger

      Total number of payouts to the registered user specified in the user property.

    • payouts_receivedinteger

      Number of payouts that are made to the registered user specified in the user property.

    • payout_planstring
      Options: SINGLE_PAYMENTTRUE_INSTALLMENTACCELERATED_INSTALLMENT

      Payout plan of the registered user at the time when the transaction was made.

    • transaction_idTransaction ID

      Unique ID of the transaction.

    • client_transaction_idstring

      Client-specific ID of the transaction.

    • userstringformat: email

      Email address of the registered user (merchant) to whom the payment is made.

    • typestring
      Options: PAYMENTREFUNDCHARGE_BACK

      Type of the transaction for the registered user specified in the user property.

    • card_typeCard Type
      Options: ALELOAMEXCONECSCUPDINERSDISCOVEREFTPOSELOELVGIROCARDHIPERCARDINTERACJCBMAESTROMASTERCARDPLUXEESWILETICKETVISAVISA_ELECTRONVISA_VPAYVPAYVRUNKNOWN

      Issuing card network of the payment card used for the transaction.

    • payout_datestringformat: date

      Payout date (if paid out at once).

      Example: "2019-08-28"
    • payout_typestring
      Options: BANK_ACCOUNTPREPAID_CARD

      Payout type.

      Example: "BANK_ACCOUNT"
    • refunded_amountnumber

      Total refunded amount.

      0
  • links[]TransactionsHistoryLink

    Hypermedia link used for transaction history pagination.

     Show attributes
     Close
    Transactions History Link
    • relstringrequired

      Relation.

      Example: "next"
    • hrefstringrequired

      Location.

      Example: "limit=10&oldest_ref=090df9bf-93b7-40f1-8181-fbdb236568a1&order=ascending"
GET/v2.1/merchants/{merchant_code}/transactions/history
curl https://api.sumup.com/v2.1/merchants/{merchant_code}/transactions/history \
 -X GET \
 -H "Authorization: Bearer $SUMUP_API_KEY"
import SumUp from '@sumup/sdk';


const client = new SumUp();


const result = await client.transactions.list("MH4H92C7");
using SumUp;


var client = new SumUpClient();


var result = await client.Transactions.ListAsync(
    "MH4H92C7"
);
import com.sumup.sdk.SumUpClient;


SumUpClient client = SumUpClient.builder().build();


var result = client.transactions().listTransactionsV2_1(
  "MH4H92C7"
);
from sumup import Sumup


client = Sumup()


result = client.transactions.list("MH4H92C7")
$sumup = new \SumUp\SumUp();


$result = $sumup->transactions->list('MH4H92C7');
client := sumup.NewClient()


result, err := client.Transactions.List(context.Background(), "MH4H92C7")
use sumup::Client;


let client = Client::default();


let result = client.transactions().list("MH4H92C7", sumup::ListTransactionsV2_1Params{
    transaction_code: Some("transaction_code".to_string()),
    order: Some("order".to_string()),
    limit: Some("limit".to_string()),
    users: Some(["merchant@example.com"]),
    statuses: Some("statuses[]".to_string()),
    payment_types: Some("payment_types[]".to_string()),
    entry_modes: Some("entry_modes[]".to_string()),
    types: Some("types[]".to_string()),
    changes_since: Some("changes_since".to_string()),
    newest_time: Some("newest_time".to_string()),
    newest_ref: Some("newest_ref".to_string()),
    oldest_time: Some("oldest_time".to_string()),
    oldest_ref: Some("oldest_ref".to_string()),
}).await;
Response
{
  "items": [
    {
      "transaction_code": "TEENSK4W2K",
      "amount": 10.1,
      "currency": "EUR",
      "timestamp": "2020-02-29T10:56:56.876Z",
      "status": "SUCCESSFUL",
      "payment_type": "ECOM",
      "installments_count": 1,
      "merchant_code": "MH4H92C7",
      "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
      "user": "merchant@example.com",
      "type": "PAYMENT",
      "payout_date": "2019-08-28",
      "payout_type": "BANK_ACCOUNT",
      "refunded_amount": 0
    }
  ],
  "links": []
}

Content-Type: application/json

The request is invalid for the submitted query parameters.

  • messagestring

    Short description of the error.

    Example: "Resource not found"
  • error_codestring

    Platform code for the error.

    Example: "NOT_FOUND"
Error 400
{
  "message": "Validation error",
  "error_code": "INVALID"
}
Transactions

Refund a transaction

POST/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds

Refunds an identified transaction either in full or partially.

Required scopes:payments

Path Parameters

  • merchant_codestringrequired

    Merchant code of the account that owns the payment to refund.

    Example: "MH4H92C7"
  • transaction_idstringrequired

    Unique ID of the transaction.

Body Parameters

  • amountnumber

    Amount to be refunded. Eligible amount can't exceed the amount of the transaction and varies based on country and currency. If you do not specify a value, the system performs a full refund of the transaction.

    Example: 5

Response

Returns empty response.

POST/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds
curl https://api.sumup.com/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds \
 -X POST \
 -H "Authorization: Bearer $SUMUP_API_KEY" \
 --json '{
    "amount": 5
  }'
import SumUp from '@sumup/sdk';


const client = new SumUp();


const result = await client.transactions.refund("MH4H92C7", "transaction_id", {
  amount: 5,
});
using SumUp;


var client = new SumUpClient();


var result = await client.Transactions.RefundAsync(
    "MH4H92C7",
    "transaction_id",
    new RefundTransactionBody
    {
        Amount = 5,
    }
);
import com.sumup.sdk.SumUpClient;


SumUpClient client = SumUpClient.builder().build();


var result = client.transactions().refundTransaction(
  "MH4H92C7",
  "transaction_id",
  RefundTransactionBody.builder()
    .amount(5f)
    .build()
);
from sumup import Sumup


client = Sumup()


result = client.transactions.refund("MH4H92C7", "transaction_id", RefundTransactionBody(
  amount=5,
))
$sumup = new \SumUp\SumUp();


$result = $sumup->transactions->refund('MH4H92C7', 'transaction_id', [
  'amount' => 5,
]);
client := sumup.NewClient()


result, err := client.Transactions.Refund(context.Background(), "MH4H92C7", "transaction_id", sumup.TransactionsRefundParams{
  Amount: 5,
})
use sumup::Client;


let client = Client::default();


let result = client.transactions().refund("MH4H92C7", "transaction_id", sumup::RefundTransactionBody{
  amount: 5,
}).await;

Content-Type: application/json

The requested resource does not exist.

  • messagestring

    Short description of the error.

    Example: "Resource not found"
  • error_codestring

    Platform code for the error.

    Example: "NOT_FOUND"
Error 404
{
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}