Shows out payment details

Request

Required scope: out_payment:read

Security

accountId and apiKey

Path

idstring, (uuid)required

Resource Identification

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/out_payment/{id}' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json

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.

statusstring

Status of the out payment.

Enum:"success""pending""deleted""delayed"

typestring

Type of out payment.

Enum:"normal""instant"

methodstring

Method used for the out payment.

Enum:"transfer""mb"

customerobject

Customer associated with the out payment.

accountobject

Easypay account from which the funds are transferred.

out_accountobject

Destination SEPA bank account for the out payment.

keystring

Merchant reference key for the out payment.

valuenumber, (double)

Amount to be transferred.

schedule_atstring

Scheduled date and time for the out payment (YYYY-MM-DD HH:MM:SS).

Example:"2022-09-15 20:28:58"

transactionsobject(out-payment-transactions)

Transaction related to the out payment.

created_atstring

Date and time when the out payment was created.

Example:"2022-09-15 20:28:58"

timestampstring

Timestamp of the last update or event for this out payment.

Example:"1749054192"

Response

{
  "id": "760d105e-950d-4b41-8017-cad840ca3baa",
  "status": "success",
  "type": "normal",
  "method": "transfer",
  "descriptive": "descriptive",
  "customer": {
    "id": "7e47c256-4bea-41a8-b578-727d60004c7a"
  },
  "account": {
    "id": "76f190b9-2b8a-4bd0-9490-411241a9dc81"
  },
  "out_account": {
    "id": "343a8a78-8deb-4d4a-aa41-0a9140c95346"
  },
  "key": "Example Key",
  "value": 1,
  "schedule_at": "2022-11-25 10:30:11",
  "transactions": [
    { … }
  ],
  "created_at": "2022-11-25 10:30:14"
}