Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Single Payment

Update a single Payment

Apply partial modifications to a single payment resource.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">single:update</code>

patch/single/{id}

Path parameters

idstring uuid required

Resource Identification

Request body

expiration_timestring
currencystring

ISO 4217 currency code. If not specified, the default currency is set to EUR.

keystring

A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.

Example request

{
  "currency": "EUR",
  "customer": {
    "name": "Jonh Doe",
    "email": "customer@example.com",
    "phone": "962496235",
    "phone_indicative": "351",
    "fiscal_number": "PT277712580",
    "key": "01J1PKR2RPHJNJQGFWGDYXY0KM",
    "language": "PT"
  },
  "key": "01J1PKR2RPHJNJQGFWGDYXY0KM",
  "sdd_mandate": {
    "iban": "PT50002700000001234567833",
    "key": "Sdd mandate Key Example",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "911234567",
    "account_holder": "John Doe"
  }
}

Response

OK

idstring
messagestring[]

An array of messages providing details about the response status. These messages give additional context about the operation result.

status'ok' | 'error'

Indicates the overall status of the API response. 'ok' means the request was successful, 'error' indicates there was a problem.

Example response

{
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "message": [
    "Your request was successfully created"
  ],
  "status": "ok",
  "method": {
    "entity": "11683",
    "reference": "665876931",
    "url": "https://cc.easypay.pt/v3/public/card-details/cec55ab6-bda3-4ab3-af22-04d2ad2c046a"
  },
  "customer": {
    "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb"
  }
}