Xe Mass Payments API
Xe Mass Payments API — batch/bulk cross-border payouts for Xe's platform. Documented Swagger 2.0 covering account, quote, invoice, payments, transaction, terms, and permissions resources for high-volume disbursement.
Xe Mass Payments API is one of 6 APIs that Euronet Worldwide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Mass Payments, Payouts, and Cross-Border. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 13 operations across 11 paths, organized into 7 resource areas, and defines 33 schemas. It is described by OpenAPI 2.0, at version 0.4.1.
13 operations
11 paths
33 schemas
1 DELETE9 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 13
Across 11 paths, the API surfaces 13 operations — 1 DELETE, 9 GET, 1 PATCH, 2 POST. They span 7 resource areas: Account, Invoice, Payments, Permissions, Quote, Terms, Transaction. Each is listed below with its method, path, parameters, and response codes.
Account 1
GET
/accounts
Get a list of accounts that the user has access to.
Invoice 1
GET
/invoices/{transactionId}
Get the invoice for an authorised transaction.
Payments 3
PATCH
/transactions/{transactionid}/payments/{paymentId}
Update a payment in a transaction.
GET
/transactions/{transactionid}/payments
Get a paged list of payment(s) for a transaction.
GET
/transactions/{transactionid}/payments/{paymentid}
Get a single payment.
Permissions 1
GET
/permissions
Get a list of permissions for the current user.
Quote 2
GET
/quotes/{transactionId}
Get a quote for a transaction.
POST
/quotes
Approve a quote.
Terms 1
GET
/terms
Gets the important information relating to making a transaction. This will have to be read, understood and agreed to, in order to approve a quote for a transaction.
Transaction 4
GET
/transactions
Get a paged list of transactions.
POST
/transactions
Load a list of payments.
GET
/transactions/{transactionId}
Get the details for a single transaction.
DELETE
/transactions/{transactionId}
Delete an unapproved transaction.
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are PaymentValidationResponse (30 properties), Payment (29 properties), RecipientInformation (24 properties), TransactionItem (24 properties). Each schema is shown below with its type and property counts.
EnterpriseAccount
object
"accountId" - ID of the requested account. "parentId" - ID of the parent account for the requested account. "name" - Name of the requested account.
3 properties
InvoiceResponse
object
"status" - Enum value of the status returned from getting the invoice. "statusText" - Text value of the status returned from getting the invoice. "invoiceData"…
3 properties
Invoice
object
"accountNumber" - Account number the invoice is for. "accountNameAndAddress" - Name of the account and the address for the account. "transactionReference" - Re…
9 properties
NameAddressAdapter
object
"accountName" - Name of the account. "address" - List of lines for the address of the account.
2 properties
QuoteSummaryAdapter
object
"accountId" - ID of the account for the quote. "transactionId" - ID of the transaction that received a quote. "transactionReference" - Reference for the transa…
4 properties
BankAccountAdapter
object
"currency" - Currency of the bank account. "countryCode" - Code of the country for the bank account. "accountName" - Name of the bank account. "accountNumber"…
11 properties
QuoteSettlementSummaryAdapter
object
"settlementCurrency" - Currency used for the settlement of the transaction. "totalSettlementDue" - Currency and amount for the settlement of the transaction. "…
5 properties
BankAdapter
object
"name" - Name of the bank.
1 property
CurrencyAmountAdapter
object
"units" - Amount of the currency. "currency" - Type of the currency.
2 properties
QuotePaymentSummaryAdapter
object
"settlementCurrency" - Currency used for the settlement of the transaction. "paymentCurrency" - Currency used for the payment of the transaction. "baseCurrency…
9 properties
UpdatePaymentRequest
object
"include" - Set to false to exclude a payment, true to include a payment. "data" - Data to update the payment with.
2 properties
UpdatePaymentData
object
SWIFT character only fields must match the regular expression: ^[\r\n\sa-zA-Z0-9\/\-:,'\?\(\)\.\+]$ "recipientName" - Name of the recipient as it is on the ban…
22 properties
UpdatePaymentResponse
object
"status" - Enum value of the status returned when updating a payment. "statusText" - Text that corresponds to the status given. "message" - If unsuccessful, th…
3 properties
PaymentItemPagedData
object
Generic Paged data returned for List Items. "content" - List of Data returned in the response. "totalRecords" - Result from the request. The type of the conten…
2 properties
PaymentItem
object
"paymentId" - ID of the payment. "transactionId" - ID of the transaction. "paymentAmount" - Amount of money for the payment currency. "settlementAmount" - Amou…
18 properties
DetailedPaymentItem
object
"paymentId" - ID of the payment. "paymentReference" - Xe.Api.MassPayments generated Payment Reference (only set once a transaction is approved). "paymentAmount…
16 properties
RecipientInformation
object
"clientUniqueReference" - Client's reference for a transaction. "recipientBankCountryCode" - ISO code for the country of the recipient's bank. "recipientName"…
24 properties
PermissionResponse
object
"status" - Enum value of the status returned from getting the account's permissions. "statusText" - Text value of the status returned from getting the account'…
3 properties
Permission
object
"name" - Permission name.
1 property
QuoteResponse
object
"status" - Enum value for the status of getting/approving the quote. "quote" - Details of the quote.
3 properties
Quote
object
"quoteId" - ID of the quote. "quoteTime" - Date and time that the quote was made. "transactionId" - ID of the transaction for the quote. "transactionReference"…
10 properties
QuoteSettlementSummary
object
"settlementCurrency" - Currency used for the settlement of the transaction. "totalSettlementDue" - Currency and amount for the settlement of the transaction. "…
5 properties
QuotePaymentSummary
object
"settlementCurrency" - Currency used for the settlement of the transaction. "baseCurrency" - Base currency for the currency pair. "settlementAmount" - Amount f…
8 properties
QuoteApprove
object
"transactionId" - ID of the transaction the quote is for. "quoteId" - ID of the quote to approve. "accountId" - ID of the account the quote is for. "agreeToTer…
4 properties
TransactionListItemPagedData
object
Generic Paged data returned for List Items. "content" - List of Data returned in the response. "totalRecords" - Result from the request. The type of the conten…
2 properties
TransactionListItem
object
"dateUploaded" - yyyy-MM-dd: Date that the transaction was uploaded. "transactionName" - Name of the transaction. "transactionReference" - Reference of the tra…
14 properties
PaymentList
object
"accountId" - ID of the account. "payments" - List of payments to load.
2 properties
Payment
object
SWIFT character only fields must match the regular expression: ^[\r\n\sa-zA-Z0-9\/\-:,'\?\(\)\.\+]$ "settlementCurrency" - 3 characters. ISO code for the requi…
29 properties
PaymentListResponse
object
"accountId" - ID of the account. "payments" - List of payments that failed validation and reasons why. "status" - Enum value of the status returned from loadin…
5 properties
PaymentValidationResponse
object
"validationResponse" - List of validation errors for an individual payment.
30 properties
GetTransactionResponse
object
"status" - Enum value of the status returned from getting the transaction. "statusText" - Text value of the status returned from getting the transaction. "tran…
3 properties
TransactionItem
object
"transactionName" - Name of the transaction. "accountId" - ID of the account for the transaction. "transactionId" - ID of the transaction. "transactionReferenc…
24 properties
DeleteTransactionResponse
object
"status" - Enum value of the status returned from deleting the transaction. "statusText" - Text value of the status returned from deleting the transaction.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Euronet Worldwide 5
Other APIs Euronet Worldwide publishes across the network.
Xe Currency Data API
Xe Payments API
Xe Currency Data Tradable Rates API
XETA API
Dandelion Cross-Border Payments API
#Mass Payments#Payouts#Cross-Border