Payment Models

Payment

{
    "payment_id": "string",
    "contact_id": "string",
    "trade_id": "string",
    "multipayment": "string",
    "multipayment_id": "string",
    "multipayment_unique_id": "string",
    "mass_payment_id": "string",
    "uuid": "string",
    "is_uuid_used_for_tracking": "boolean",
    "account_number": "string",
    "amount": "number",
    "bank_identifier": "string",
    "beneficiary_id": "string",
    "beneficiary_name": "string",
    "beneficiary_aml_id": "string",
    "beneficiary_active": "boolean",
    "beneficiary_authorised": "boolean",
    "beneficiary_blocked": "boolean",
    "beneficiary_completed": "boolean",
    "beneficiary_verified": "boolean",
    "created_date": "string",
    "external_reference_id": "string",
    "fee_amount": "number",
    "fee_currency": "string",
    "iban": "string",
    "payment_currency": "string",
    "payment_date": "string",
    "payment_instruction": "string",
    "payment_receipt": "string",
    "status": "string",
    "internal_status": {
        "code": "number",
        "message": "string"
    },
    "swift_code": "string",
    "authorised_by": "string",
    "authorised_date": "string",
    "rejected_by": "string",
    "rejected_date": "string",
    "cancelled": "boolean",
    "cancelled_by": "string",
    "cancelled_date": "string",
    "can_be_cancelled": "boolean",
    "authorisation_workflow": "string",
    "invoice_required": "boolean",
    "reference": "string",
    "charges": "string",
    "AML_status": "number",
    "AML_overdue": "boolean",
    "executed": "boolean",
    "fully_funded": "boolean",
    "over_paid": "boolean",
    "returned": "boolean",
    "verified": "boolean",
    "approvals_workflow": {
        "authorisations": [
            {
                "date": "string",
                "status": "number",
                "contact_id": "string",
                "level": "number",
                "contact_name": "string"
            }
        ],
        "contact_authorisation_actions": {
            "allowed": ["string"],
            "executed": "string"
        },
        "minimum_remaining_authorisations": "number",
        "n_eyes_plus_status": "string"
    }
}

This model is a representation of a payment. Fields

string

Unique identifier for the payment (Always)

string

Unique identifier of the contact who booked the payment (Always)

string

Unique identifier of the trade the payment is allocated to (Always)

string

Unique identifier for the multi payment formatted

string

Unique identifier for the multi payment

string

Internal unique reference for the multi-payment

string

Unique identifier for the mass payment

string

Unique End-to-end Transaction Reference (UETR) used for SWIFT gpi tracking.

boolean

Boolean flag indicating if the uuid can be used for SWIFT tracking. It is true only if the payment is recent (< 124 days), valid, and uses SCHEMA_SWIFT.

string

Account number of the beneficiary

number

Payment amount

string

The identifier of the beneficiary’s bank

string

Unique identifier for the beneficiary

string

Name of the beneficiary

string

Beneficiary ID formatted

boolean

Indicates if the beneficiary account is currently active

boolean

Indicates if the beneficiary has been authorised in the system

boolean

Indicates if the beneficiary is blocked from receiving payments

boolean

Indicates if the beneficiary profile setup is complete

boolean

Indicates if the beneficiary identity/account has been verified

string

Payment instruction created date

string

Unique reference submitted by the client to identify the payment

number

Fee amount

string

Fee currency

string

The IBAN of the beneficiary’s bank account

string

Name of the contact who ordered the payment

string

Currency the payment was made in

string

Target payment date. YYYY-MM-DD format

string

URI to download payment instruction

string

URI to download payment receipt

string

Simplified representation of the payment status designed for easy consumption in client applications. See Status

object

The raw/detailed internal status used by the system to track the complete lifecycle of payments. See Internal Status

string

The SWIFT code of the beneficiary’s bank account

string

The user who authorised the payment

string

The date when payment was authorised

string

The user who rejected the payment

string

The date when payment was rejected

boolean

Boolean flag indicating if the payment has been cancelled

string

The user who cancelled the payment

string

The date when payment was cancelled

boolean

Boolean indicating if the payment is currently in a state that allows cancellation

string

The authorisation workflow of the payment. Acceptable values:

simple
4-eyes

boolean

Whether or not the payment requires an invoice

string

The payment reference

string

Charges applied to the payment

number

Numerical status code representing the AML check result

boolean

Indicates if the AML verification process has exceeded the expected timeframe

boolean

Boolean indicating if the payment has been successfully executed

boolean

Indicates if the account has sufficient funds to cover the payment

boolean

Indicates if the payment amount exceeds the trade or balance allocation

boolean

Boolean indicating if the payment was returned by the receiving bank

boolean

Indicates if the payment details have been verified

object

New approvals workflow related fields. See Approvals Workflow

Status

A simplified representation of the payment status designed for easy consumption in client applications. Values

Value	Description
`Need more beneficiary information`	Beneficiary information is not complete, more details are required.
`Validating beneficiary information`	Beneficiary information is complete, but not validated yet.
`Waiting for payment date`	Payment is ready to be executed, waiting for payment execution date.
`Payment complete`	Payment has been executed.
`Executing Payment`	Payment is in the process of being executed.
`Payment pending of authorization`	Payment has been verified but not authorised.
`Payment rejected`	Payment has been rejected.
`Payment cancelled`	Payment has been cancelled.

Payment Status Filter

Valid values for the status query parameter when filtering payments. Values

Value	Description
`pending`	Payments not yet executed (excludes completed, rejected, and cancelled).
`pending_to_authorise`	Payments awaiting authorisation.
`authorised`	Payments that have been authorised.
`cancelled`	Payments that have been cancelled.
`rejected`	Payments that have been rejected.
`complete`	Payments that have been fully executed.
`pending_your_approval`	(N-Eyes Plus) Payments awaiting approval from the current contact.
`pending_others_approval`	(N-Eyes Plus) Payments awaiting approval from other contacts.

Internal Status

The raw/detailed internal status used by the system to track the complete lifecycle of payments. Values

Status	CODE	Description
START	0	Initial state
CREATED	1	Payment created
PENDING_OF_AUTHORIZATION	2	Awaiting authorization
AUTHORISED	3	Payment authorized
REJECTED	4	Payment rejected
CANCELLED	5	Payment cancelled
DELIVERED	6	Payment delivered
DISCARDED	7	Payment discarded
QUERIED	8	Payment queried
AMENDED	9	Payment amended
MESSAGED	10	Message sent
ABORTED	11	Process aborted
RECONCILED	12	Payment reconciled
PENDING_RETURN	13	Awaiting return
RETURNED	14	Payment returned
INVALIDATED	15	Payment invalidated
CLOSED	16	Payment closed

Payment Fee

{
    "fee_amount": "number",
    "fee_currency": "string",
    "payment_amount": "number",
    "payment_country": "string",
    "payment_currency": "string",
    "payment_instruction": "number",
    "payment_is_intra": "boolean"
}

This model is a representation of a payment fee. Fields

number

Fee amount (Always)

string

Fee currency (Always)

number

Payment amount

string

Currency the payment was made in (Always)

string

The destination country of the payment (Always)

number

Payment instruction (Always)

boolean

True if payment is Ebury intra payments, False otherwise

Approvals Workflow

For clients that have NEyes Plus enabled, the payments will go through the new Approvals Workflow, which means the following fields will be populated:

Value	Description
`authorisations`	List of current authorisations the payment has already received. Includes the date when the payment was approved / rejected and the contact identifier and name
`contact_authorisation_actions`	Includes `allowed` actions for the current contact (`approve` / `reject` if the contact is allowed to perform those actions according to the Approvals Workflow, and `cancel` for the creator of the payment) and the `executed` action, if any
`n_eyes_plus_status`	Neyes Plus status of the payment

​Payment

​Status

​Payment Status Filter

​Internal Status

​Payment Fee

​Approvals Workflow

Payment

Status

Payment Status Filter

Internal Status

Payment Fee

Approvals Workflow