getneo
  1. Payments
getneo
  • Introduction
  • API examples
  • Technical topics
    • API structure
    • HTTP headers
    • Decoupled responses
    • Validation failures (418)
  • Endpoints
    • Auth
      • Get service bearer token (password)
        GET
      • Change tenant
        GET
      • End session
        GET
    • Counterparties
      • Get all counterparties
        GET
      • Get counterparty by ID
        GET
      • Get draft counterparty by ID
        GET
      • Submit counterparty draft
        POST
      • Update counterparty draft
        POST
      • Delete a counterparty draft
        DELETE
      • Add account to counterparty
        POST
      • Update counterparty account
        PATCH
      • Export counterparty data
        POST
    • Payments
      • Get all payments
        GET
      • Get a payment by ID
        GET
      • Make a payment (deposit, withdrawal or internal)
        POST
  1. Payments

Get all payments

Demo
https://trade.demo.getneo.com
Demo
https://trade.demo.getneo.com
GET
/api/v3/payments
Returns payment details including, source/destination and intermediary account information
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://trade.demo.getneo.com/api/v3/payments'
Response Response Example
[
    {
        "actions": [
            "string"
        ],
        "bookedDate": "2019-08-24T14:15:22Z",
        "chargePrice": {
            "amount": 0,
            "currency": "EUR",
            "minorUnit": 0
        },
        "client": {
            "id": "stringstringstringstri",
            "name": "string"
        },
        "clientOrderId": "string",
        "confirmationDocument": {
            "id": "string",
            "uri": "string"
        },
        "destination": {
            "account": {
                "bankCode": "string",
                "bankName": "string",
                "bicSwift": "NEOPESBB",
                "country": "ESP",
                "iban": "string",
                "ibanType": "private",
                "id": "stringstringstringstri",
                "name": "string",
                "number": "string",
                "routingNumber": "string",
                "sortCodeUK": "string",
                "type": "internal"
            },
            "corp": {
                "avatarUrl": "string",
                "id": "stringstringstringstri",
                "name": "string"
            },
            "isIban": true,
            "isInternal": true,
            "owner": {
                "address": {
                    "address1": "string",
                    "address2": "string",
                    "city": "string",
                    "country": "ESP",
                    "county": "string",
                    "postCode": "string"
                },
                "emailAddress": "string",
                "firstName": "string",
                "id": "stringstringstringstri",
                "lastName": "string",
                "name": "string",
                "unregistered": true
            }
        },
        "externalSettlementInstructions": {
            "accountHolder": "string",
            "accountHolderAddress": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "country": "ESP",
                "county": "string",
                "postCode": "string"
            },
            "accountNumber": "string",
            "bankName": "string",
            "bicSwift": "string",
            "countryCode": "string",
            "iban": "string",
            "isIban": true,
            "settlementAmount": {
                "amountActual": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "amountBase": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0,
                    "rate": 0
                },
                "baseFixingRate": 0,
                "conversionRate": 0
            }
        },
        "externalSettlementSource": {
            "accountHolder": "string",
            "accountHolderAddress": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "country": "ESP",
                "county": "string",
                "postCode": "string"
            },
            "accountNumber": "string",
            "bankName": "string",
            "bicSwift": "string",
            "countryCode": "string",
            "iban": "string",
            "isIban": true,
            "settlementAmount": {
                "amountActual": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "amountBase": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0,
                    "rate": 0
                },
                "baseFixingRate": 0,
                "conversionRate": 0
            }
        },
        "iban": {
            "alias": "string",
            "bankName": "string",
            "bic": "string",
            "corpName": "string",
            "country": "string",
            "currencies": [
                "string"
            ],
            "iban": "string",
            "ibanType": "string",
            "id": "string"
        },
        "id": "stringstringstringstri",
        "linkedDocuments": {
            "count": 0,
            "uri": "string"
        },
        "network": "string",
        "operator": {
            "avatarUrl": "string",
            "id": "stringstringstringstri",
            "name": "string"
        },
        "orderType": "nonFx",
        "originalValueDate": "2019-08-24T14:15:22Z",
        "paymentAmount": {
            "amount": 0,
            "currency": "EUR",
            "minorUnit": 0
        },
        "paymentEstimatedDate": "2019-08-24T14:15:22Z",
        "paymentFees": {
            "amountActual": {
                "amount": 0,
                "currency": "EUR",
                "minorUnit": 0
            },
            "amountBase": {
                "amount": 0,
                "currency": "EUR",
                "minorUnit": 0,
                "rate": 0
            },
            "baseFixingRate": 0,
            "conversionRate": 0,
            "paymentChargeType": "sha",
            "paymentFee": 0,
            "paymentFeeCurrencyCode": "EUR",
            "paymentFeeDate": "2019-08-24T14:15:22Z",
            "paymentNetwork": "swift",
            "paymentPriority": "none"
        },
        "paymentPurpose": "string",
        "paymentReference": "string",
        "paymentTags": "string",
        "paymentType": "none",
        "priority": "string",
        "priorityCharge": {
            "amount": 0,
            "currency": "EUR",
            "minorUnit": 0
        },
        "relatedTrade": {
            "actions": [
                "string"
            ],
            "approvedBy": {
                "avatarUrl": "string",
                "id": "stringstringstringstri",
                "name": "string"
            },
            "commission": {
                "amountActual": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "amountBase": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0,
                    "rate": 0
                },
                "amountInvoice": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0,
                    "rate": 0
                },
                "baseFixingRate": 0,
                "commissionMin": {
                    "amountActual": {
                        "amount": 0,
                        "currency": "EUR",
                        "minorUnit": 0
                    },
                    "amountBase": {
                        "amount": 0,
                        "currency": "EUR",
                        "minorUnit": 0,
                        "rate": 0
                    },
                    "amountInvoice": {
                        "amount": 0,
                        "currency": "EUR",
                        "minorUnit": 0,
                        "rate": 0
                    },
                    "baseFixingRate": 0,
                    "conversionRate": 0
                },
                "commissionMinApplied": true,
                "commissionPcnt": 0,
                "conversionRate": 0
            },
            "commissionCurrency": "string",
            "confirmationDocument": {
                "id": "string",
                "uri": "string"
            },
            "corp": {
                "id": "stringstringstringstri",
                "name": "string"
            },
            "dateBooked": "2019-08-24T14:15:22Z",
            "dateTraded": "2019-08-24T14:15:22Z",
            "id": "string",
            "isAllIn": true,
            "isRFQ": true,
            "legs": [
                {
                    "action": "buy",
                    "actions": [
                        "string"
                    ],
                    "amount": {
                        "amountActual": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0
                        },
                        "amountBase": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0,
                            "rate": 0
                        },
                        "baseFixingRate": 0,
                        "conversionRate": 0
                    },
                    "buyAmount": {
                        "amountActual": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0
                        },
                        "amountBase": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0,
                            "rate": 0
                        },
                        "baseFixingRate": 0,
                        "conversionRate": 0
                    },
                    "ccyBuy": "string",
                    "ccyPair": "string",
                    "ccySell": "string",
                    "clientReference": "string",
                    "externalSettlementInstructionsDestination": {
                        "accountHolder": "string",
                        "accountHolderAddress": {
                            "address1": "string",
                            "address2": "string",
                            "city": "string",
                            "country": "ESP",
                            "county": "string",
                            "postCode": "string"
                        },
                        "accountNumber": "string",
                        "bankName": "string",
                        "bicSwift": "string",
                        "countryCode": "string",
                        "iban": "string",
                        "isIban": true,
                        "settlementAmount": {
                            "amountActual": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0
                            },
                            "amountBase": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0,
                                "rate": 0
                            },
                            "baseFixingRate": 0,
                            "conversionRate": 0
                        }
                    },
                    "externalSettlementInstructionsSource": {
                        "accountHolder": "string",
                        "accountHolderAddress": {
                            "address1": "string",
                            "address2": "string",
                            "city": "string",
                            "country": "ESP",
                            "county": "string",
                            "postCode": "string"
                        },
                        "accountNumber": "string",
                        "bankName": "string",
                        "bicSwift": "string",
                        "countryCode": "string",
                        "iban": "string",
                        "isIban": true,
                        "settlementAmount": {
                            "amountActual": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0
                            },
                            "amountBase": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0,
                                "rate": 0
                            },
                            "baseFixingRate": 0,
                            "conversionRate": 0
                        }
                    },
                    "floatAmount": {
                        "amountActual": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0
                        },
                        "amountBase": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0,
                            "rate": 0
                        },
                        "baseFixingRate": 0,
                        "conversionRate": 0
                    },
                    "fundsTakenOnSubmit": true,
                    "legOrderId": "string",
                    "margin": {
                        "percent": 0,
                        "value": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0
                        }
                    },
                    "marketInfo": {
                        "amountBoughtLP": {
                            "amountActual": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0
                            },
                            "amountBase": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0,
                                "rate": 0
                            },
                            "baseFixingRate": 0,
                            "conversionRate": 0
                        },
                        "amountSoldLP": {
                            "amountActual": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0
                            },
                            "amountBase": {
                                "amount": 0,
                                "currency": "EUR",
                                "minorUnit": 0,
                                "rate": 0
                            },
                            "baseFixingRate": 0,
                            "conversionRate": 0
                        },
                        "lpName": "string",
                        "lpTradeRef": "string",
                        "rateLP": {
                            "ccy1": "string",
                            "ccy2": "string",
                            "forwardPoints": 0,
                            "pipSize": 0,
                            "rate": 0,
                            "timestamp": "string"
                        },
                        "venueName": "string",
                        "venueTradeId": "string"
                    },
                    "payFrom": [
                        {
                            "account": {
                                "accountId": "string",
                                "accountNumber": "string",
                                "accountType": "wallet",
                                "alias": "string",
                                "counterpartyId": "string"
                            },
                            "iban": {
                                "alias": "string",
                                "bankName": "string",
                                "bic": "string",
                                "corpName": "string",
                                "country": "string",
                                "currencies": [
                                    "string"
                                ],
                                "iban": "string",
                                "ibanType": "string",
                                "id": "string"
                            },
                            "primaryWallet": {
                                "accountNumber": "string",
                                "currency": "string",
                                "id": "string",
                                "name": "string",
                                "type": "unspecified",
                                "walletName": "string",
                                "walletState": "accountVerified",
                                "walletType": "unspecified"
                            }
                        }
                    ],
                    "payTo": [
                        {
                            "account": {
                                "accountId": "string",
                                "accountNumber": "string",
                                "accountType": "wallet",
                                "alias": "string",
                                "counterpartyId": "string"
                            },
                            "amount": 0,
                            "counterparty": {
                                "accounts": [
                                    {
                                        "accountNumber": "string",
                                        "actions": [
                                            "string"
                                        ],
                                        "additionalCountryAccountInfo": "string",
                                        "alias": "string",
                                        "bank": "string",
                                        "bankAccountId": "string",
                                        "bankCode": "string",
                                        "bic_swift": "string",
                                        "country": "string",
                                        "currencies": [
                                            "string"
                                        ],
                                        "iban": "string",
                                        "intermediaryBank": "string",
                                        "isBeneficiary": true,
                                        "isPayer": true,
                                        "operatorInfo": "string",
                                        "parentId": "string",
                                        "recurringReference": "string",
                                        "routingNumber": "string",
                                        "sortCodeUK": "string"
                                    }
                                ],
                                "actions": [
                                    "string"
                                ],
                                "address1": "string",
                                "address2": "string",
                                "alias": "string",
                                "city": "string",
                                "country": "string",
                                "county": "string",
                                "currencies": [
                                    "string"
                                ],
                                "draft": {},
                                "email": "string",
                                "firstName": "string",
                                "id": "string",
                                "isBeneficiary": true,
                                "isPayer": true,
                                "isSelf": true,
                                "lastName": "string",
                                "name": "string",
                                "paymentReason": [
                                    "string"
                                ],
                                "postCode": "string",
                                "primaryType": "string",
                                "shortfall": 0,
                                "shortfallCurrencyCode": "string",
                                "state": "draft",
                                "status": "draft",
                                "subsidiary": "string",
                                "subType": "string",
                                "thirdPartyType": "string",
                                "thirdPartyTypeOther": "string",
                                "vanityId": "string"
                            },
                            "currency": "string",
                            "iban": {
                                "alias": "string",
                                "bankName": "string",
                                "bic": "string",
                                "corpName": "string",
                                "country": "string",
                                "currencies": [
                                    "string"
                                ],
                                "iban": "string",
                                "ibanType": "string",
                                "id": "string"
                            },
                            "paymentFees": {
                                "amountActual": {
                                    "amount": 0,
                                    "currency": "EUR",
                                    "minorUnit": 0
                                },
                                "amountBase": {
                                    "amount": 0,
                                    "currency": "EUR",
                                    "minorUnit": 0,
                                    "rate": 0
                                },
                                "baseFixingRate": 0,
                                "conversionRate": 0,
                                "paymentChargeType": "sha",
                                "paymentFee": 0,
                                "paymentFeeCurrencyCode": "EUR",
                                "paymentFeeDate": "2019-08-24T14:15:22Z",
                                "paymentNetwork": "swift",
                                "paymentPriority": "none"
                            },
                            "paymentPurpose": "string",
                            "paymentReference": "string",
                            "paymentRouteId": 0,
                            "paymentTag": "string",
                            "primaryWallet": {
                                "accountNumber": "string",
                                "currency": "string",
                                "id": "string",
                                "name": "string",
                                "type": "unspecified",
                                "walletName": "string",
                                "walletState": "accountVerified",
                                "walletType": "unspecified"
                            }
                        }
                    ],
                    "rateAllIn": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "rateBooked": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "rateFilled": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "rateLastFixing": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "rateNonAllIn": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "rateTraded": {
                        "ccy1": "string",
                        "ccy2": "string",
                        "forwardPoints": 0,
                        "pipSize": 0,
                        "rate": 0,
                        "timestamp": "string"
                    },
                    "sellAmount": {
                        "amountActual": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0
                        },
                        "amountBase": {
                            "amount": 0,
                            "currency": "EUR",
                            "minorUnit": 0,
                            "rate": 0
                        },
                        "baseFixingRate": 0,
                        "conversionRate": 0
                    },
                    "state": "clientOrderNew",
                    "tenor": "tod",
                    "valueDate": "2019-08-24T14:15:22Z"
                }
            ],
            "m2m": {
                "fairValue": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "lastUpdate": "2019-08-24T14:15:22Z",
                "m2mValue": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "rateM2m": {
                    "ccy1": "string",
                    "ccy2": "string",
                    "forwardPoints": 0,
                    "pipSize": 0,
                    "rate": 0,
                    "timestamp": "string"
                },
                "rateM2mLp": {
                    "ccy1": "string",
                    "ccy2": "string",
                    "forwardPoints": 0,
                    "pipSize": 0,
                    "rate": 0,
                    "timestamp": "string"
                }
            },
            "margin": {
                "percent": 0,
                "value": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                }
            },
            "maxValueDate": "2019-08-24T14:15:22Z",
            "operator": {
                "avatarUrl": "string",
                "id": "stringstringstringstri",
                "name": "string"
            },
            "owner": {
                "avatarUrl": "string",
                "id": "stringstringstringstri",
                "name": "string"
            },
            "parentOrderId": "string",
            "paymentCount": 0,
            "quote": {
                "forwardPoints": 0,
                "legs": [
                    {
                        "rate": {
                            "ccy1": "string",
                            "ccy2": "string",
                            "forwardPoints": 0,
                            "pipSize": 0,
                            "rate": 0,
                            "timestamp": "string"
                        },
                        "reverse": {
                            "ccy1": "string",
                            "ccy2": "string",
                            "forwardPoints": 0,
                            "pipSize": 0,
                            "rate": 0,
                            "timestamp": "string"
                        }
                    }
                ]
            },
            "quoteId": "string",
            "receivedAdvisory": true,
            "reference": "string",
            "relatedPaymentOrders": [
                {}
            ],
            "rfqId": "string",
            "rfqTTL": "2019-08-24T14:15:22Z",
            "skipPhoneConfirmation": true,
            "source": "platform",
            "spot": {
                "rate": {
                    "askForwardPoints": 0,
                    "askRate": 0,
                    "bidForwardPoints": 0,
                    "bidRate": 0,
                    "ccy1": "string",
                    "ccy2": "string",
                    "pipSize": 0
                },
                "reverse": {
                    "askForwardPoints": 0,
                    "askRate": 0,
                    "bidForwardPoints": 0,
                    "bidRate": 0,
                    "ccy1": "string",
                    "ccy2": "string",
                    "pipSize": 0
                },
                "tenor": "tod",
                "valueDate": "2019-08-24T14:15:22Z"
            },
            "state": "clientOrderNew",
            "swapInfo": {
                "category": "swap",
                "delta": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "linkedClientOrderId": "string",
                "linkedToTrade": true,
                "linkedTradeId": "string",
                "points": 0
            },
            "tradeLimits": {
                "max": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                },
                "min": {
                    "amount": 0,
                    "currency": "EUR",
                    "minorUnit": 0
                }
            },
            "tradeType": "nonFx",
            "transactionType": "payment",
            "useAllInPrice": true,
            "vanityId": "string",
            "warnings": [
                {
                    "property1": [
                        {}
                    ],
                    "property2": [
                        {}
                    ]
                }
            ]
        },
        "rowVersion": "d14f8d40-9efc-44ee-b911-4936b0a9b6cc",
        "source": {
            "account": {
                "bankCode": "string",
                "bankName": "string",
                "bicSwift": "NEOPESBB",
                "country": "ESP",
                "iban": "string",
                "ibanType": "private",
                "id": "stringstringstringstri",
                "name": "string",
                "number": "string",
                "routingNumber": "string",
                "sortCodeUK": "string",
                "type": "internal"
            },
            "additionalInfo": "string",
            "corp": {
                "avatarUrl": "string",
                "id": "stringstringstringstri",
                "name": "string"
            },
            "isIban": true,
            "isInternal": true,
            "owner": {
                "address": {
                    "address1": "string",
                    "address2": "string",
                    "city": "string",
                    "country": "ESP",
                    "county": "string",
                    "postCode": "string"
                },
                "emailAddress": "string",
                "firstName": "string",
                "id": "stringstringstringstri",
                "lastName": "string",
                "name": "string",
                "unregistered": true
            }
        },
        "state": "orderPaymentNew",
        "totalCost": {
            "amount": 0,
            "currency": "EUR",
            "minorUnit": 0
        },
        "trackingSource": {
            "sourceName": "string",
            "uetr": "string"
        },
        "tradeType": "string",
        "validator": {
            "avatarUrl": "string",
            "id": "stringstringstringstri",
            "name": "string"
        },
        "validatorComment": "string",
        "valueDate": "2019-08-24T14:15:22Z",
        "vanityId": "string",
        "warnings": [
            {
                "property1": [
                    {}
                ],
                "property2": [
                    {}
                ]
            }
        ]
    }
]

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200OK
application/json
The array of payments viewable by the requester have returned
Body

🟠401Unauthorized
🟠403Forbidden
Modified at 2025-07-17 17:17:32
Previous
Export counterparty data
Next
Get a payment by ID
Built with