Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Out Payment

Create out payment

Get your strong authentication RSA private key from Easypay Backoffice on menu:</br>Web Services->Configuration API 2.0->Keys.

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

post/out_payment

Request body

keystring

Merchant identification key

valuenumber double required

Value will be rounded to 2 decimals

type'normal' | 'instant'

Optional - only applicable to method transfer

schedule_atstring

Scheduled date and time to execute the payment, in YYYY-MM-DD HH:MM format (UTC, no timezone suffix).

descriptivestring

Description for the out payment.

method'transfer' | 'mb' required
timestampstring required

Unix timestamp UTC, must be no more than 1 minute before or after real time, if not the strong authentication signature will not be valid

Example request

{
  "customer": {
    "id": "649e88cf-0b78-4c36-8f99-33f5ebb812a1",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "911234567",
    "phone_indicative": "+351",
    "fiscal_number": "PT123456789",
    "key": "customer Key Example",
    "language": "PT"
  },
  "schedule_at": "2026-04-24 16:25",
  "method": "transfer"
}

Response

Created

statusstring
messagestring[]
idstring uuid

A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

Example response

{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "method": {
    "status": "pending"
  }
}