SUsumup
Readers

Create a Go Reader Payment

Changed on

Initiates a payment on the SumUp Go terminal identified by the reader ID.

Use client_transaction_id as an idempotency key: retrying the request with the same value returns the result of the original payment instead of creating a duplicate.

post/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: payments, readers.write

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

reader_idstring required

Unique identifier of the reader that the payment is initiated on.

Example:rdr_3MSAFM23CK82VSTT4BN6RWSQ65

The unique identifier of the reader.

Request body

client_transaction_idstring required

Caller-supplied correlation identifier, used as the idempotency key.

tip_amountinteger

Portion of total_amount that is a tip, in minor units.

Example request

{
  "affiliate": {
    "app_id": "com.example.app",
    "key": "123e4567-e89b-12d3-a456-426614174000"
  },
  "client_transaction_id": "19e12390-72cf-4f9f-80b5-b0c8a67fa43f",
  "tip_amount": 200,
  "total_amount": {
    "currency": "MXN",
    "value": 1000
  }
}

Response

Returns the result of the payment initiated on the reader.

Example response

{
  "data": {
    "client_transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transaction_code": "TEENSK4W2K"
  }
}

Changes

  • 0f66b0a52002Revision changes
    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      added subschema #1 to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

  • e3f010a5edddRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      removed the non-success response with the status