Skip to content
/
Create out payment

Create out payment

Request

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

Required scope: out_payment:create

Security
accountId and apiKey and signatureAuth
Bodyapplication/json
customerobject(Customer)required

The Customer object contains the necessary details about the customer involved in the transaction. This includes identification information, contact details, and preferences. All fields are optional unless specified otherwise.

keystring, <= 50 characters

Merchant identification key

valuenumber, (double), >= 0.5required

Value will be rounded to 2 decimals

typestring

Optional - only applicable to method transfer

Default:"normal"
Enum:"normal""instant"
schedule_atstring

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

Example:"2026-04-24 16:25"
descriptivestring, <= 140 characters^[a-zA-Z0-9 .,/+*$%]+$

Description for the out payment.

accountobject(Account)
out_accountobject(out-account)required
methodstringrequired
Default:"transfer"
Enum:"transfer""mb"
Example:"transfer"
timestampstringrequired

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

curl -i -X POST \
  https://api.test.easypay.pt/2.0/out_payment \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92' \
  -H 'Content-Type: application/json' \
  -H 'Signature: YOUR_API_KEY_HERE' \
  -d '{
    "customer": {
      "name": "Customer Example",
      "email": "user@example.com",
      "phone": "911234567",
      "phone_indicative": "+351",
      "fiscal_number": "PT123456789",
      "key": "Example Key",
      "language": "PT"
    },
    "key": "Example Key",
    "value": 0.5,
    "type": "normal",
    "schedule_at": "2026-04-24 16:25",
    "descriptive": "Descriptive Example",
    "out_account": {
      "account_holder": "Acount Name Example",
      "iban": "PT50002700000001234567833",
      "email": "customer@example.com",
      "phone": "351911234567",
      "key": "Key Example",
      "country_code": "PT"
    },
    "method": "transfer",
    "timestamp": "1696642539"
  }'

Responses

Created

Bodyapplication/json
statusstring
Example:"ok"
messageArray of strings
Example:
[
  "Your request was successfully created"
]
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.

methodobject
customerobject

Customer associated with the out payment.

out_accountobject

Destination SEPA bank account for the out payment.

Response
{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "c6056234-a3f9-42de-b944-3ed793fcb6bb",
  "method": {
    "type": "transfer",
    "status": "pending"
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "out_account": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}