{"swagger":"2.0","info":{"version":"0.4.1","title":"Xe.Api.MassPayments"},"paths":{"/accounts":{"get":{"tags":["Account"],"summary":"Get a list of accounts that the user has access to.","description":"Permissions Required:\r\n            \r\n    CanGetAccounts\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /accounts","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Returns the list of accounts.","schema":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/EnterpriseAccount"}},"examples":{"application/json":[{"accountId":112186376,"parentId":0,"name":"Joe Smith"},{"accountId":112186529,"parentId":112186376,"name":"John Smith"}]}},"500":{"description":"Error getting accounts."}}}},"/invoices/{transactionId}":{"get":{"tags":["Invoice"],"summary":"Get the invoice for an authorised transaction.","description":"Permissions Required:\r\n            \r\n    CanViewInvoice\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /invoices/4251","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of transaction to get the invoice for.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the invoice.","schema":{"$ref":"#/definitions/InvoiceResponse"},"examples":{"application/json":{"status":0,"statusText":"Success","invoiceData":{"accountNumber":"HIFX0221672388","accountNameAndAddress":{"accountName":"Joe Smith","address":["4 Lime Street","United Kingdom"]},"transactionReference":"MPT126437","uploadedBy":"Joe Smith","approvedBy":"Joe Smith","numberOfPayments":2,"numberOfSettlementTypePayments":0,"quoteSummary":{"accountId":112186376,"transactionId":35271,"transactionReference":"MPT126437","settlementSummary":[{"settlementCurrency":"USD","totalSettlementDue":{"units":1921.48,"currency":"USD"},"totalFees":{"units":8.6,"currency":"USD"},"totalNumberOfPayments":1,"paymentSummary":[{"settlementCurrency":"USD","paymentCurrency":"GBP","baseCurrency":"GBP","settlementAmount":{"units":1921.48,"currency":"USD"},"paymentAmount":{"units":1100,"currency":"GBP"},"numberOfPayments":1,"quotedRate":1.7468,"fee":{"units":8.6,"currency":"USD"},"valueDate":"2018-12-04"}]}]},"settlementBankAccounts":[{"currency":"USD","countryCode":"US","accountName":"Leah McWilliams","accountNumber":"1231231234","branchAddressOne":"100 North Tryon Street","branchAddressTwo":"Charlotte","branchAddressThree":"","iban":"","nationalClearingCode":"26009593","swiftBic":"BOFAUS3N","bank":{"name":"Bank Name"}}]}}}},"202":{"description":"Invoice is not ready.","schema":{"$ref":"#/definitions/InvoiceResponse"},"examples":{"application/json":{"status":1,"statusText":"InvoiceNotAvailable","invoiceData":null}}},"401":{"description":"No access to account."},"404":{"description":"Transaction not found.","schema":{"$ref":"#/definitions/InvoiceResponse"},"examples":{"application/json":{"status":2,"statusText":"TransactionNotFound","invoiceData":null}}},"500":{"description":"Error getting invoice."}}}},"/transactions/{transactionid}/payments/{paymentId}":{"patch":{"tags":["Payments"],"summary":"Update a payment in a transaction.","description":"Permissions Required:\r\n            \r\n    CanEditPayments\r\n            \r\n\\\r\nSample request:\r\n            \r\n    PATCH /transactions/35271/payments/107346","operationId":"Update","consumes":["application/json-patch+json","application/json","text/json","application/*+json"],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of the transaction.","required":true,"type":"integer","format":"int32"},{"name":"paymentId","in":"path","description":"ID of the payment.","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"Body containing details to update.","required":false,"schema":{"$ref":"#/definitions/UpdatePaymentRequest"}}],"responses":{"204":{"description":"Payment was successfully updated."},"400":{"description":"Request data is invalid or transaction cannot be updated.","schema":{"$ref":"#/definitions/UpdatePaymentResponse"},"examples":{"application/json":{"status":3,"statusText":"TransactionApproved","message":"Transaction must be in 'not approved' state to be modified"}}},"401":{"description":"No access to account."},"404":{"description":"Transaction or payment not found.","schema":{"$ref":"#/definitions/UpdatePaymentResponse"},"examples":{"application/json":{"status":1,"statusText":"TransactionNotFound","message":"Transaction could not be found"}}},"500":{"description":"Error updating payment."}}}},"/transactions/{transactionid}/payments":{"get":{"tags":["Payments"],"summary":"Get a paged list of payment(s) for a transaction.","description":"Permissions Required:\r\n            \r\n    CanViewPayments\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /transactions/35271/payments?pagesize=10","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of the transaction the requested payments belong to.","required":true,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The page to return.","required":false,"type":"integer","format":"int32","default":1},{"name":"pageSize","in":"query","description":"The number of transactions per page.","required":false,"type":"integer","format":"int32","default":6}],"responses":{"200":{"description":"Returns a paged list of payment.","schema":{"$ref":"#/definitions/PaymentItemPagedData"},"examples":{"application/json":{"content":[{"paymentId":111490,"transactionId":30477,"paymentAmount":1100,"settlementAmount":0,"paymentCurrency":"GBP","settlementCurrency":"USD","clientsUniquePaymentReference":"123634537","recipientAccountName":"TestRecipient","targetDate":"2019-06-15","paymentDate":null,"rejected":false,"forReview":true,"isTargetDateAchievable":true,"isReadOnly":true,"isExcluded":false,"issues":[],"paymentStatus":"OK","hasBeenApproved":false},{"paymentId":111553,"transactionId":546,"paymentAmount":1100,"settlementAmount":0,"paymentCurrency":"GBP","settlementCurrency":"USD","clientsUniquePaymentReference":"","recipientAccountName":"TestRecipient","targetDate":"2019-06-15","paymentDate":null,"rejected":false,"forReview":true,"isTargetDateAchievable":false,"isReadOnly":false,"isExcluded":false,"issues":["The IBAN's Country does not match the Destination Country"],"paymentStatus":"For Review","hasBeenApproved":true}],"totalRecords":2}}},"500":{"description":"Error getting payments."}}}},"/transactions/{transactionid}/payments/{paymentid}":{"get":{"tags":["Payments"],"summary":"Get a single payment.","description":"Permissions Required:\r\n\r\n    CanViewPayments\r\n    \r\n\\\r\nSample request:\r\n\r\n    GET /transactions/35271/payments/107346","operationId":"GetSingle","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of the transaction the request payment belongs to.","required":true,"type":"integer","format":"int32"},{"name":"paymentId","in":"path","description":"ID of the payment to get.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the requested payment.","schema":{"$ref":"#/definitions/DetailedPaymentItem"},"examples":{"application/json":{"paymentId":123456,"paymentReference":"P654321","paymentAmount":51234.56,"paymentCurrency":"USD","settlementAmount":40000,"settlementCurrency":"GBP","amountType":1,"recipientInformation":{"clientUniqueReference":"1236345","recipientBankCountryCode":"US","recipientName":"Leah McWilliams","recipientEmail":"test@example.com","recipientAddress1":"4 Apple Street","recipientAddress2":"","recipientAddressCountryCode":"US","recipientAccountNumberIBAN":"1231231234","recipientBIC":"BOFAUS3N","recipientNationalClearingCode":"","recipientBankName":"Bank Name","recipientBankAddress1":"100 North Tryon Street","recipientBankAddress2":"Charlotte","recipientBankAddress3":"","clientPaymentReference":"Monthly Contract Pay 743001","intermediaryBankName":"","intermediaryBankAddress1":"","intermediaryBankAddress2":"","intermediaryBankAddress3":"","intermediaryBankCountryCode":"","intermediaryAccountNumberIBAN":"","intermediaryBIC":"","intermediaryNationalClearingCode":"","reasonForPayment":"Dividend"},"targetDate":"2020-05-02","isTargetDateAchievable":false,"paymentDate":"2020-05-06","createdTimestamp":"2020-05-05T20:04:56.7929832Z","modifiedTimestamp":"2020-05-05T20:34:56.7929833Z","paymentStatus":"Not Sent","issues":null,"canEdit":true}}},"404":{"description":"Transaction or payment not found."},"500":{"description":"Error getting payment."}}}},"/permissions":{"get":{"tags":["Permissions"],"summary":"Get a list of permissions for the current user.","description":"Sample request:\r\n            \r\n    GET /permissions","operationId":"List","consumes":[],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Returns list of permissions.","schema":{"$ref":"#/definitions/PermissionResponse"},"examples":{"application/json":{"status":0,"statusText":"Success","permissions":[{"name":"CanGetAccounts"},{"name":"CanViewTransactions"},{"name":"CanViewPayments"},{"name":"CanLoadTransactions"},{"name":"CanDeleteTransactions"},{"name":"CanGetQuote"},{"name":"CanApproveQuote"},{"name":"CanViewInvoice"},{"name":"CanEditPayments"}]}}},"500":{"description":"Error getting permissions."}}}},"/quotes/{transactionId}":{"get":{"tags":["Quote"],"summary":"Get a quote for a transaction.","description":"Permissions Required:\r\n            \r\n    CanGetQuote\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /quotes/6724","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of transaction to quote for.","required":true,"type":"integer","format":"int32"},{"name":"accountId","in":"query","description":"ID of account the transaction is for. If not set, it defaults to the user's account.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the generated quote.","schema":{"$ref":"#/definitions/QuoteResponse"},"examples":{"application/json":{"status":0,"statusText":"Success","quote":{"quoteId":"cb22f338-7bb8-4ad1-88fd-a69bfaeade7d","quoteTime":"2018-12-02T10:15:00","transactionId":35271,"transactionReference":"MPT126437","settlementSummary":[{"settlementCurrency":"USD","totalSettlementDue":1921.48,"totalFees":8.6,"totalNumberOfPayments":1,"paymentSummary":[{"currency":"GBP","baseCurrency":"GBP","settlementAmount":1921.48,"paymentAmount":1100,"numberOfPayments":1,"quotedRate":1.7468,"fee":8.6,"valueDate":"2018-12-04"}]}],"transactionName":"72648193-2a7d-ff39-c120-266dac5810e2","uploadedBy":"Joe Smith","dateUploaded":"2018-12-02","status":1,"quoteStatusText":"Valid"}}}},"400":{"description":"Transaction is not in a valid state to be quoted.","schema":{"$ref":"#/definitions/QuoteResponse"},"examples":{"application/json":{"status":9,"statusText":"TransactionDeleted","quote":null}}},"401":{"description":"No access to account."},"404":{"description":"Transaction not found."},"500":{"description":"Error generating quote."}}}},"/quotes":{"post":{"tags":["Quote"],"summary":"Approve a quote.","description":"Permissions Required:\r\n            \r\n    CanApproveQuote\r\n            \r\n\\\r\nSample request:\r\n            \r\n    POST /quotes","operationId":"Approve","consumes":["application/json-patch+json","application/json","text/json","application/*+json"],"produces":["application/json"],"parameters":[{"name":"approveData","in":"body","description":"IDs needed to approve the quote.","required":false,"schema":{"$ref":"#/definitions/QuoteApprove"}}],"responses":{"200":{"description":"Quote approved.","schema":{"$ref":"#/definitions/QuoteResponse"},"examples":{"application/json":{"status":0,"statusText":"Success","quote":{"quoteId":"cb22f338-7bb8-4ad1-88fd-a69bfaeade7d","quoteTime":"2018-12-02T10:15:00","transactionId":35271,"transactionReference":"MPT126437","settlementSummary":[{"settlementCurrency":"USD","totalSettlementDue":1921.48,"totalFees":8.6,"totalNumberOfPayments":1,"paymentSummary":[{"currency":"GBP","baseCurrency":"GBP","settlementAmount":1921.48,"paymentAmount":1100,"numberOfPayments":1,"quotedRate":1.7468,"fee":8.6,"valueDate":"2018-12-04"}]}],"transactionName":"72648193-2a7d-ff39-c120-266dac5810e2","uploadedBy":"Joe Smith","dateUploaded":"2018-12-02","status":1,"quoteStatusText":"Valid"}}}},"400":{"description":"Quote is not in a valid state to be approved.","schema":{"$ref":"#/definitions/QuoteResponse"},"examples":{"application/json":{"status":9,"statusText":"TransactionDeleted","quote":null}}},"401":{"description":"No access to account."},"404":{"description":"Quote not found."},"500":{"description":"Error approving quote."}}}},"/terms":{"get":{"tags":["Terms"],"summary":"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.","description":"Sample request:\r\n            \r\n    GET /terms","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Returns the important information."},"500":{"description":"Error getting the important information."}}}},"/transactions":{"get":{"tags":["Transaction"],"summary":"Get a paged list of transactions.","description":"Permissions Required:\r\n            \r\n    CanViewTransactions\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /transactions?pagesize=10\r\n            \r\n\\\r\nSort columns:\r\n            \r\n    DateUploaded\r\n    TransactionName\r\n    TransactionReference\r\n    TransactionStatus\r\n    NumberOfPayments\r\n    ApprovedBy\r\n            \r\n\\\r\nSort directions:\r\n            \r\n    desc\r\n    asc","operationId":"Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"accountId","in":"query","description":"ID of account the transactions are for. If not set, it defaults to the user's account.","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"The page to return.","required":false,"type":"integer","format":"int32","default":1},{"name":"pageSize","in":"query","description":"The number of transactions per page.","required":false,"type":"integer","format":"int32","default":6},{"name":"sortCol","in":"query","description":"Column to sort on.","required":false,"type":"string","default":"DateUploaded"},{"name":"sortDir","in":"query","description":"Sort direction.","required":false,"type":"string","default":"desc"}],"responses":{"200":{"description":"Returns a paged list of transactions.","schema":{"$ref":"#/definitions/TransactionListItemPagedData"},"examples":{"application/json":{"content":[{"dateUploaded":"2018-12-02","transactionName":"72648193-2a7d-ff39-c120-266dac5810e2","transactionReference":null,"transactionStatus":3,"transactionStatusText":"NotApproved","uploadedBy":"Joe Smith","approvedBy":null,"numberOfPayments":2,"settlementStatus":"Sent","paymentStatus":"NotSent","queriedPayments":2,"failureStatusType":"ValidationOK","reasonsForFailure":[""],"transactionId":35271},{"dateUploaded":"2018-12-01","transactionName":"66619964-8ea2-d28b-0a2f-440bd17ac782","transactionReference":null,"transactionStatus":2,"transactionStatusText":"Failed","uploadedBy":"Joe Smith","approvedBy":null,"numberOfPayments":0,"settlementStatus":"Sent","paymentStatus":"NotSent","queriedPayments":0,"failureStatusType":"BasicValidationFailed","reasonsForFailure":["Payment validation failed:","Line 1: Your Unique Payment ID \"123\" already exists in a previous Payment File"],"transactionId":35270}],"totalRecords":2}}},"400":{"description":"Bad sort column."},"500":{"description":"Error getting transactions."}}},"post":{"tags":["Transaction"],"summary":"Load a list of payments.","description":"Permissions Required:\r\n            \r\n    CanLoadTransactions\r\n            \r\n\\\r\nSample request:\r\n            \r\n    POST /transactions","operationId":"Post","consumes":["application/json-patch+json","application/json","text/json","application/*+json"],"produces":["application/json"],"parameters":[{"name":"paymentList","in":"body","description":"List of payments to load.","required":false,"schema":{"$ref":"#/definitions/PaymentList"}}],"responses":{"202":{"description":"Returns the transaction ID and status of the load.","schema":{"$ref":"#/definitions/PaymentListResponse"},"examples":{"application/json":{"accountId":112186376,"payments":null,"status":1,"statusText":"Processing","transactionId":35271}}},"401":{"description":"No access to account."},"422":{"description":"At least one payment failed validation.","schema":{"$ref":"#/definitions/PaymentListResponse"},"examples":{"application/json":{"accountId":112186376,"payments":[{"validationResponse":["Settlement Currency : Settlement currency only allows letters"],"settlementCurrency":"&%!","targetPaymentDate":"2018-12-04","paymentCurrency":"GBP","amount":"1100","amountType":1,"clientUniqueReference":"1236345","recipientBankCountryCode":"US","recipientName":"Leah McWilliams","recipientEmail":"test@example.com","recipientAddress1":"4 Apple Street","recipientAddress2":"","recipientAddressCountryCode":"US","recipientAccountNumberIBAN":"1231231234","recipientBIC":"BOFAUS3N","recipientNationalClearingCode":"","recipientBankName":"Bank Name","recipientBankAddress1":"100 North Tryon Street","recipientBankAddress2":"Charlotte","recipientBankAddress3":"","clientPaymentReference":"Monthly Contract Pay 743001","intermediaryBankName":"","intermediaryBankAddress1":"","intermediaryBankAddress2":"","intermediaryBankAddress3":"","intermediaryBankCountryCode":"","intermediaryAccountNumberIBAN":"","intermediaryBIC":"","intermediaryNationalClearingCode":"","reasonForPayment":"Contract Payment"}],"status":5,"statusText":"ValidationFailed","transactionId":0}}},"500":{"description":"Error loading payments."}}}},"/transactions/{transactionId}":{"get":{"tags":["Transaction"],"summary":"Get the details for a single transaction.","description":"Permissions Required:\r\n            \r\n    CanViewTransactions\r\n            \r\n\\\r\nSample request:\r\n            \r\n    GET /transactions/35271","operationId":"GetTransaction","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of the transaction.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns a single transaction.","schema":{"$ref":"#/definitions/GetTransactionResponse"},"examples":{"application/json":{"status":0,"statusText":"Success","transaction":{"transactionName":"72648193-2a7d-ff39-c120-266dac5810e2","accountId":112186376,"transactionId":35271,"transactionReference":null,"transactionStatus":3,"transactionStatusText":"NotApproved","dateUploaded":"2018-12-02","uploadedBy":"Joe Smith","approved":false,"dateApproved":null,"approvedBy":null,"settlementStatus":"Sent","paymentStatus":"NotSent","numberOfPayments":2,"queriedPayments":2,"includedQueriedPayments":2,"rejectedPayments":0,"excludedPayments":0,"approvedPayments":0,"sentPayments":0,"reasonsForFailure":[""],"failureStatusType":"ValidationOK","canQuote":true,"canDelete":true}}}},"401":{"description":"No access to account."},"404":{"description":"Transaction not found."},"500":{"description":"Error getting transaction."}}},"delete":{"tags":["Transaction"],"summary":"Delete an unapproved transaction.","description":"Permissions Required:\r\n            \r\n    CanDeleteTransactions\r\n            \r\n\\\r\nSample request:\r\n            \r\n    DELETE /transactions/4682","operationId":"Delete","consumes":[],"produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"ID of transaction to delete.","required":true,"type":"integer","format":"int32"}],"responses":{"202":{"description":"Transaction was not deleted.","schema":{"$ref":"#/definitions/DeleteTransactionResponse"},"examples":{"application/json":{"status":2,"statusText":"TransactionApproved"}}},"204":{"description":"Successfully deleted transaction."},"401":{"description":"No access to account."},"404":{"description":"Transaction not found.","schema":{"$ref":"#/definitions/DeleteTransactionResponse"},"examples":{"application/json":{"status":1,"statusText":"TransactionNotFound"}}},"500":{"description":"Error deleting transaction."}}}}},"definitions":{"EnterpriseAccount":{"description":"\"accountId\" - ID of the requested account.\r\n\"parentId\" - ID of the parent account for the requested account.\r\n\"name\" - Name of the requested account.","type":"object","properties":{"accountId":{"format":"int32","type":"integer"},"parentId":{"format":"int32","type":"integer"},"name":{"type":"string"}}},"InvoiceResponse":{"description":"\"status\" - Enum value of the status returned from getting the invoice.\r\n\"statusText\" - Text value of the status returned from getting the invoice.\r\n\"invoiceData\" - If successful, the invoice is returned.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = InvoiceNotAvailable\n2 = TransactionNotFound","enum":[0,1,2],"type":"integer"},"statusText":{"type":"string","readOnly":true},"invoiceData":{"$ref":"#/definitions/Invoice"}}},"Invoice":{"description":"\"accountNumber\" - Account number the invoice is for.\r\n\"accountNameAndAddress\" - Name of the account and the address for the account.\r\n\"transactionReference\" - Reference for the transaction the invoice is for.\r\n\"uploadedBy\" - Name of the person who uploaded the transaction and when it was uploaded in UTC format (yyyy-MM-ddThh:mm:ssZ).\r\n\"approvedBy\" - Name of the person who approved the quote for the transcation and when it was approved in UTC format (yyyy-MM-ddThh:mm:ssZ).\r\n\"numberOfPayments\" - Number of payments within the transaction.\r\n\"numberOfSettlementTypePayments\" - Number of payments that are settlements.\r\n\"quoteSummary\" - Details for the quote that was approved.\r\n\"settlementBankAccounts\" - Bank accounts that are being used to settle the transaction payments.","type":"object","properties":{"accountNumber":{"type":"string"},"accountNameAndAddress":{"$ref":"#/definitions/NameAddressAdapter"},"transactionReference":{"type":"string"},"uploadedBy":{"type":"string"},"approvedBy":{"type":"string"},"numberOfPayments":{"format":"int32","type":"integer"},"numberOfSettlementTypePayments":{"format":"int32","type":"integer"},"quoteSummary":{"$ref":"#/definitions/QuoteSummaryAdapter"},"settlementBankAccounts":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/BankAccountAdapter"}}}},"NameAddressAdapter":{"description":"\"accountName\" - Name of the account.\r\n\"address\" - List of lines for the address of the account.","type":"object","properties":{"accountName":{"type":"string"},"address":{"uniqueItems":false,"type":"array","items":{"type":"string"}}}},"QuoteSummaryAdapter":{"description":"\"accountId\" - ID of the account for the quote.\r\n\"transactionId\" - ID of the transaction that received a quote.\r\n\"transactionReference\" - Reference for the transaction that received a quote.\r\n\"settlementSummary\" - Details for the settlement of the quote.","type":"object","properties":{"accountId":{"format":"int32","type":"integer"},"transactionId":{"format":"int32","type":"integer"},"transactionReference":{"type":"string"},"settlementSummary":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/QuoteSettlementSummaryAdapter"}}}},"BankAccountAdapter":{"description":"\"currency\" - Currency of the bank account.\r\n\"countryCode\" - Code of the country for the bank account.\r\n\"accountName\" - Name of the bank account.\r\n\"accountNumber\" - Number of the bank account.\r\n\"branchAddressOne\" - First line of the branch address.\r\n\"branchAddressTwo\" - Second line of the branch address.\r\n\"branchAddressThree\" - Third line of the branch address.\r\n\"iban\" - IBAN of the bank account.\r\n\"nationalClearingCode\" - NCC of the bank account.\r\n\"swiftBic\" - Swift/BIC of the bank account.\r\n\"bank\" - Details of the bank for the bank account.","type":"object","properties":{"currency":{"type":"string"},"countryCode":{"type":"string"},"accountName":{"type":"string"},"accountNumber":{"type":"string"},"branchAddressOne":{"type":"string"},"branchAddressTwo":{"type":"string"},"branchAddressThree":{"type":"string"},"iban":{"type":"string"},"nationalClearingCode":{"type":"string"},"swiftBic":{"type":"string"},"bank":{"$ref":"#/definitions/BankAdapter"}}},"QuoteSettlementSummaryAdapter":{"description":"\"settlementCurrency\" - Currency used for the settlement of the transaction.\r\n\"totalSettlementDue\" - Currency and amount for the settlement of the transaction.\r\n\"totalFees\" - Currency and amount for the total fees of the transfer process.\r\n\"totalNumberOfPayments\" - Total number of payments for the transaction.\r\n\"paymentSummary\" - Details for the payment of the quote.","type":"object","properties":{"settlementCurrency":{"type":"string"},"totalSettlementDue":{"$ref":"#/definitions/CurrencyAmountAdapter"},"totalFees":{"$ref":"#/definitions/CurrencyAmountAdapter"},"totalNumberOfPayments":{"format":"int32","type":"integer"},"paymentSummary":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/QuotePaymentSummaryAdapter"}}}},"BankAdapter":{"description":"\"name\" - Name of the bank.","type":"object","properties":{"name":{"type":"string"}}},"CurrencyAmountAdapter":{"description":"\"units\" - Amount of the currency.\r\n\"currency\" - Type of the currency.","type":"object","properties":{"units":{"format":"double","type":"number"},"currency":{"type":"string"}}},"QuotePaymentSummaryAdapter":{"description":"\"settlementCurrency\" - Currency used for the settlement of the transaction.\r\n\"paymentCurrency\" - Currency used for the payment of the transaction.\r\n\"baseCurrency\" - Base currency for the currency pair.\r\n\"settlementAmount\" - Amount for the settlement of the transaction.\r\n\"paymentAmount\" - Amount for the payment of the transaction.\r\n\"numberOfPayments\" - Number of payments in the transaction.\r\n\"quotedRate\" - Agreed rate for the currency conversion when it was quoted.\r\n\"fee\" - Amount agreed for the transfer process.\r\n\"valueDate\" - yyyy-MM-dd: Effective date of the transfer.","type":"object","properties":{"settlementCurrency":{"type":"string"},"paymentCurrency":{"type":"string"},"baseCurrency":{"type":"string"},"settlementAmount":{"$ref":"#/definitions/CurrencyAmountAdapter"},"paymentAmount":{"$ref":"#/definitions/CurrencyAmountAdapter"},"numberOfPayments":{"format":"int32","type":"integer"},"quotedRate":{"format":"double","type":"number"},"fee":{"$ref":"#/definitions/CurrencyAmountAdapter"},"valueDate":{"type":"string"}}},"UpdatePaymentRequest":{"description":"\"include\" - Set to false to exclude a payment, true to include a payment.\r\n\"data\" - Data to update the payment with.","type":"object","properties":{"include":{"type":"boolean"},"data":{"$ref":"#/definitions/UpdatePaymentData"}},"example":{"include":false,"data":{"recipientName":"Leah McWilliams","recipientEmail":"test@example.com","recipientAddress1":"4 Apple Street","recipientAddress2":"","recipientAddressCountryCode":"US","recipientAccountNumberIBAN":"1231231234","recipientBIC":"BOFAUS3N","recipientNationalClearingCode":"","recipientBankName":"Bank Name","recipientBankAddress1":"100 North Tryon Street","recipientBankAddress2":"Charlotte","recipientBankAddress3":"","clientPaymentReference":"Monthly Contract Pay 743001","intermediaryBankName":"","intermediaryBankAddress1":"","intermediaryBankAddress2":"","intermediaryBankAddress3":"","intermediaryBankCountryCode":"","intermediaryAccountNumberIBAN":"","intermediaryBIC":"","intermediaryNationalClearingCode":"","reasonForPayment":"Contract Payment"}}},"UpdatePaymentData":{"description":"SWIFT character only fields must match the regular expression: ^[\\r\\n\\sa-zA-Z0-9\\/\\-:,'\\?\\(\\)\\.\\+]*$\r\n\r\n\"recipientName\" - Name of the recipient as it is on the bank account. SWIFT characters only.\r\n\"recipientEmail\" - Email address of the recipient, if they require an individual payment confirmation.\r\n\"recipientAddress1\" - First line of the recipient's address. SWIFT characters only.\r\n\"recipientAddress2\" - Second line of the recipient's address. SWIFT characters only.\r\n\"recipientAddressCountryCode\" - ISO code for the country of the recipient's address.\r\n\"recipientAccountNumberIban\" - Account number or IBAN for the recipient's bank account. SWIFT characters only.\r\n\"recipientBic\" - BIC of the recipient's bank. SWIFT characters only.\r\n\"recipientNationalClearingCode\" - National clearing code of the recipient's bank. SWIFT characters only.\r\n\"recipientBankName\" - Name of the recipient's bank. SWIFT characters only.\r\n\"recipientBankAddress1\" - First line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"recipientBankAddress2\" - Second line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"recipientBankAddress3\" - Third line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"clientPaymentReference\" - Additional reference that is included in the payment details sent to the bank. SWIFT characters only.\r\n\"intermediaryBankName\" - Name of any intermediary bank. SWIFT characters only.\r\n\"intermediaryBankAddress1\" - First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankAddress2\" - First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankAddress3\" - First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankCountryCode\" - ISO code for the country of any intermediary bank account.\r\n\"intermediaryAccountNumberIban\" - Account number or IBAN for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBic\" - BIC of any intermediary bank account. SWIFT characters only.\r\n\"intermediaryNationalClearingCode\" - National clearing code of any intermediary bank account.\r\n\"reasonForPayment\" - Reason for making the payment. SWIFT characters only.","type":"object","properties":{"recipientName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientAddress1":{"type":"string"},"recipientAddress2":{"type":"string"},"recipientAddressCountryCode":{"type":"string"},"recipientAccountNumberIBAN":{"type":"string"},"recipientBIC":{"type":"string"},"recipientNationalClearingCode":{"type":"string"},"recipientBankName":{"type":"string"},"recipientBankAddress1":{"type":"string"},"recipientBankAddress2":{"type":"string"},"recipientBankAddress3":{"type":"string"},"clientPaymentReference":{"type":"string"},"intermediaryBankName":{"type":"string"},"intermediaryBankAddress1":{"type":"string"},"intermediaryBankAddress2":{"type":"string"},"intermediaryBankAddress3":{"type":"string"},"intermediaryBankCountryCode":{"type":"string"},"intermediaryAccountNumberIBAN":{"type":"string"},"intermediaryBIC":{"type":"string"},"intermediaryNationalClearingCode":{"type":"string"},"reasonForPayment":{"type":"string"}}},"UpdatePaymentResponse":{"description":"\"status\" - Enum value of the status returned when updating a payment.\r\n\"statusText\" - Text that corresponds to the status given.\r\n\"message\" - If unsuccessful, the reason why will be given.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = TransactionNotFound\n2 = PaymentNotFound\n3 = TransactionApproved\n4 = Unsuccessful\n5 = ValidationFailed\n6 = PaymentNoIssues","enum":[0,1,2,3,4,5,6],"type":"integer"},"statusText":{"type":"string","readOnly":true},"message":{"type":"string"}}},"PaymentItemPagedData":{"description":"Generic Paged data returned for List Items.\r\n            \r\n\"content\" - List of Data returned in the response.\r\n\"totalRecords\" - Result from the request.\r\n<typeparam name=\"T\">The type of the content.</typeparam>","type":"object","properties":{"content":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/PaymentItem"}},"totalRecords":{"format":"int32","type":"integer"}}},"PaymentItem":{"description":"\"paymentId\" - ID of the payment.\r\n\"transactionId\" - ID of the transaction.\r\n\"paymentAmount\" - Amount of money for the payment currency.\r\n\"settlementAmount\" - Amount of money for the settlement currency.\r\n\"paymentCurrency\" - ISO code of the required payment currency.\r\n\"settlementCurrency\" - ISO code for the required settlement currency.\r\n\"clientsUniquePaymentReference\" -  Client’s reference for a transaction.\r\n\"recipientAccountName\" - Name of the recipient as it is on the bank account.\r\n\"targetDate\" - Date that the payment should credit the recipient, expressed as yyyy-MM-dd.\r\n\"paymentDate\" - Date that the payment will be credit the recipient. This will usually be the same as target date unless it is not achievable in which case it is calculated after approving the transaction, expressed as yyyy-MM-dd.\r\n\"paymentStatus\" - Status of the progress of sending the payments for the transaction.\r\n\"rejected\" - Boolean value for if the payment is rejected or not.\r\n\"forReview\" - Boolean value for if the payment is in review.\r\n\"IsTargetDateAchievable\" - Boolean value for whether the target date is achievable or not.\r\n\"isReadOnly\" - Boolean value for whether the payment is ReadOnly or not.\r\n\"IsExcluded\" - Boolean value for whether the payment is excluded or not.\r\n\"issues\" - Listed issues for the payment.\r\n\"HasBeenApproved\" - Boolean value for whether the payment has been approved or not.","type":"object","properties":{"paymentId":{"format":"int32","type":"integer"},"transactionId":{"format":"int32","type":"integer"},"paymentAmount":{"format":"double","type":"number"},"settlementAmount":{"format":"double","type":"number"},"paymentCurrency":{"type":"string"},"settlementCurrency":{"type":"string"},"clientsUniquePaymentReference":{"type":"string"},"recipientAccountName":{"type":"string"},"targetDate":{"type":"string"},"paymentDate":{"type":"string"},"rejected":{"type":"boolean"},"forReview":{"type":"boolean"},"isTargetDateAchievable":{"type":"boolean"},"isReadOnly":{"type":"boolean"},"isExcluded":{"type":"boolean"},"issues":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"paymentStatus":{"type":"string","readOnly":true},"hasBeenApproved":{"type":"boolean"}}},"DetailedPaymentItem":{"description":"\"paymentId\" - ID of the payment.\r\n\"paymentReference\" - Xe.Api.MassPayments generated Payment Reference (only set once a transaction is approved).\r\n\"paymentAmount\" - Amount of money for the payment currency.\r\n\"paymentCurrency\" - ISO code of the required payment currency.\r\n\"settlementAmount\" - Amount of money for the settlement currency.\r\n\"settlementCurrency\" - ISO code for the required settlement currency.\r\n\"amountType\" - Indication on whether this is a payment or settlement.\r\n\"recipientInformation\" - The payment recipient's details.\r\n\"targetDate\" - Date that the payment should credit the recipient, expressed as yyyy-MM-dd.\r\n\"IsTargetDateAchievable\" - Boolean value for whether the target date is achievable or not.\r\n\"paymentDate\" - Date that the payment will be credit the recipient. This will usually be the same as target date unless it is not achievable in which case it is calculated after approving the transaction, expressed as yyyy-MM-dd.\r\n\"createdTimestamp\" - UTC Timestamp that the payment was created. Once a transaction is approved, this timestamp will be updated to the point it was approved.\r\n\"modifiedTimestamp\" - UTC Timestamp that any changes were made to the payment. If changes were made and then the transaction was approved, this value is reset.\r\n\"paymentStatus\" - Status of the progress of sending the payments for the transaction.\r\n\"issues\" - Listed issues for the payment.\r\n\"canEdit\" - Flag to indicate whether or not the payment can be edited.","type":"object","properties":{"paymentId":{"format":"int32","type":"integer"},"paymentReference":{"type":"string"},"paymentAmount":{"format":"double","type":"number"},"paymentCurrency":{"type":"string"},"settlementAmount":{"format":"double","type":"number"},"settlementCurrency":{"type":"string"},"amountType":{"format":"int32","description":"\n0 = NotSet\n1 = Payment\n2 = Settlement","enum":[0,1,2],"type":"integer"},"recipientInformation":{"$ref":"#/definitions/RecipientInformation"},"targetDate":{"type":"string"},"isTargetDateAchievable":{"type":"boolean"},"paymentDate":{"type":"string"},"createdTimestamp":{"format":"date-time","type":"string"},"modifiedTimestamp":{"format":"date-time","type":"string"},"paymentStatus":{"type":"string","readOnly":true},"issues":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"canEdit":{"type":"boolean","readOnly":true}}},"RecipientInformation":{"description":"\"clientUniqueReference\" - Client's reference for a transaction.\r\n\"recipientBankCountryCode\" - ISO code for the country of the recipient's bank.\r\n\"recipientName\" - Name of the recipient as it is on the bank account.\r\n\"recipientEmail\" - Email address of the recipient, if they require an individual payment confirmation.\r\n\"recipientAddress1\" - First line of the recipient's address.\r\n\"recipientAddress2\" - Second line of the recipient's address.\r\n\"recipientAddressCountryCode\" - ISO code for the country of the recipient's address.\r\n\"recipientAccountNumberIban\" - Account number or IBAN for the recipient's bank account.\r\n\"recipientBic\" - BIC of the recipient's bank.\r\n\"recipientNationalClearingCode\" - National clearing code of the recipient's bank.\r\n\"recipientBankName\" - Name of the recipient's bank.\r\n\"recipientBankAddress1\" - First line of the address for the recipient’s bank account.\r\n\"recipientBankAddress2\" - Second line of the address for the recipient’s bank account.\r\n\"recipientBankAddress3\" - Third line of the address for the recipient’s bank account.\r\n\"clientPaymentReference\" -Additional reference that is included in the payment details sent to the bank.\r\n\"intermediaryBankName\" - Name of any intermediary bank.\r\n\"intermediaryBankAddress1\" - First line of the address for any intermediary bank account.\r\n\"intermediaryBankAddress2\" - First line of the address for any intermediary bank account.\r\n\"intermediaryBankAddress3\" - First line of the address for any intermediary bank account.\r\n\"intermediaryBankCountryCode\" - ISO code for the country of any intermediary bank account.\r\n\"intermediaryAccountNumberIban\" - Account number or IBAN for any intermediary bank account.\r\n\"intermediaryBic\" - BIC of any intermediary bank account.\r\n\"intermediaryNationalClearingCode\" - National clearing code of any intermediary bank account.\r\n\"reasonForPayment\" - Reason for making the payment.","type":"object","properties":{"clientUniqueReference":{"type":"string"},"recipientBankCountryCode":{"type":"string"},"recipientName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientAddress1":{"type":"string"},"recipientAddress2":{"type":"string"},"recipientAddressCountryCode":{"type":"string"},"recipientAccountNumberIBAN":{"type":"string"},"recipientBIC":{"type":"string"},"recipientNationalClearingCode":{"type":"string"},"recipientBankName":{"type":"string"},"recipientBankAddress1":{"type":"string"},"recipientBankAddress2":{"type":"string"},"recipientBankAddress3":{"type":"string"},"clientPaymentReference":{"type":"string"},"intermediaryBankName":{"type":"string"},"intermediaryBankAddress1":{"type":"string"},"intermediaryBankAddress2":{"type":"string"},"intermediaryBankAddress3":{"type":"string"},"intermediaryBankCountryCode":{"type":"string"},"intermediaryAccountNumberIBAN":{"type":"string"},"intermediaryBIC":{"type":"string"},"intermediaryNationalClearingCode":{"type":"string"},"reasonForPayment":{"type":"string"}}},"PermissionResponse":{"description":"\"status\" - Enum value of the status returned from getting the account's permissions.\r\n\"statusText\" - Text value of the status returned from getting the account's permissions.\r\n\"permissions\" - List of permissions the current account has.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = AccountNotKycApproved\n2 = UserNotFound\n3 = UserInactive\n4 = UserNotKycApproved\n5 = AccountNotFound","enum":[0,1,2,3,4,5],"type":"integer"},"statusText":{"type":"string","readOnly":true},"permissions":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Permission"}}}},"Permission":{"description":"\"name\" - Permission name.","type":"object","properties":{"name":{"type":"string"}}},"QuoteResponse":{"description":"\"status\" - Enum value for the status of getting/approving the quote.\r\n\"quote\" - Details of the quote.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = FailedToQuote\n2 = TransactionInvalidStatus\n3 = QuoteLimitExceeded\n4 = QuoteNotFoundOrExpired\n5 = TransactionLoadInProgress\n6 = TransactionQuoteApproved\n7 = TransactionLoadError\n8 = TransactionNotFound\n9 = TransactionDeleted\n10 = SameCurrencyFeeBandNotConfigured\n11 = TermsNotAgreedTo","enum":[0,1,2,3,4,5,6,7,8,9,10,11],"type":"integer"},"statusText":{"type":"string","readOnly":true},"quote":{"$ref":"#/definitions/Quote"}}},"Quote":{"description":"\"quoteId\" - ID of the quote.\r\n\"quoteTime\" - Date and time that the quote was made.\r\n\"transactionId\" - ID of the transaction for the quote.\r\n\"transactionReference\" - Reference for the transaction.\r\n\"settlementSummary\" - Details for the settlement of the quote.\r\n\"transactionName\" - Name of the transaction.\r\n\"uploadedBy\" - Name of the person who uploaded the transaction.\r\n\"dateUploaded\" - yyyy-MM-dd: Date that the transaction was uploaded.\r\n\"status\" - Enum value of the status returned from getting the quote.\r\n\"quoteStatusText\" - Text value of the status returned from getting the quote.","type":"object","properties":{"quoteId":{"format":"uuid","type":"string"},"quoteTime":{"format":"date-time","type":"string"},"transactionId":{"format":"int32","type":"integer"},"transactionReference":{"type":"string"},"settlementSummary":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/QuoteSettlementSummary"}},"transactionName":{"type":"string"},"uploadedBy":{"type":"string"},"dateUploaded":{"type":"string"},"status":{"format":"int32","description":"\n0 = NotSet\n1 = Valid\n2 = RequiresManual\n3 = Timeout\n4 = Rejected\n5 = Missing\n6 = UnableToQuote\n7 = Error","enum":[0,1,2,3,4,5,6,7],"type":"integer"},"quoteStatusText":{"type":"string","readOnly":true}}},"QuoteSettlementSummary":{"description":"\"settlementCurrency\" - Currency used for the settlement of the transaction.\r\n\"totalSettlementDue\" - Currency and amount for the settlement of the transaction.\r\n\"totalFees\" - Currency and amount for the total fees of the transfer process.\r\n\"totalNumberOfPayments\" - Total number of payments for the transaction.\r\n\"paymentSummary\" - Details for the payment of the quote.","type":"object","properties":{"settlementCurrency":{"type":"string"},"totalSettlementDue":{"format":"double","type":"number"},"totalFees":{"format":"double","type":"number"},"totalNumberOfPayments":{"format":"int32","type":"integer"},"paymentSummary":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/QuotePaymentSummary"}}}},"QuotePaymentSummary":{"description":"\"settlementCurrency\" - Currency used for the settlement of the transaction.\r\n\"baseCurrency\" - Base currency for the currency pair.\r\n\"settlementAmount\" - Amount for the settlement of the transaction.\r\n\"paymentAmount\" - Amount for the payment of the transaction.\r\n\"numberOfPayments\" - Number of payments in the transaction.\r\n\"quotedRate\" - Agreed rate for the currency conversion when it was quoted.\r\n\"fee\" - Amount agreed for the transfer process.\r\n\"valueDate\" - yyyy-MM-dd: Effective date of the transfer.","type":"object","properties":{"currency":{"type":"string"},"baseCurrency":{"type":"string"},"settlementAmount":{"format":"double","type":"number"},"paymentAmount":{"format":"double","type":"number"},"numberOfPayments":{"format":"int32","type":"integer"},"quotedRate":{"format":"double","type":"number"},"fee":{"format":"double","type":"number"},"valueDate":{"type":"string"}}},"QuoteApprove":{"description":"\"transactionId\" - ID of the transaction the quote is for.\r\n\"quoteId\" - ID of the quote to approve.\r\n\"accountId\" - ID of the account the quote is for.\r\n\"agreeToTerms\" - Whether the important information given by the /terms endpoint is agreed to. This must be true to approve a quote.","type":"object","properties":{"transactionId":{"format":"int32","type":"integer"},"quoteId":{"type":"string"},"accountId":{"format":"int32","type":"integer"},"agreeToTerms":{"type":"boolean"}},"example":{"transactionId":4387,"quoteId":"e42630ea-4214-d7f9-eb94-2f4bb50f6fcf","accountId":3124,"agreeToTerms":true}},"TransactionListItemPagedData":{"description":"Generic Paged data returned for List Items.\r\n            \r\n\"content\" - List of Data returned in the response.\r\n\"totalRecords\" - Result from the request.\r\n<typeparam name=\"T\">The type of the content.</typeparam>","type":"object","properties":{"content":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/TransactionListItem"}},"totalRecords":{"format":"int32","type":"integer"}}},"TransactionListItem":{"description":"\"dateUploaded\" - yyyy-MM-dd: Date that the transaction was uploaded.\r\n\"transactionName\" - Name of the transaction.\r\n\"transactionReference\" - Reference of the transaction.\r\n\"transactionStatus\" - Enum value of the status returned from getting the transaction.\r\n\"transactionStatusText\" - Text value of the status returned from getting the transaction.\r\n\"uploadedBy\" - Name of the person who uploaded the transaction.\r\n\"approvedBy\" - Name of the person who approved the quote for the transaction.\r\n\"numberOfPayments\" - Number of payments for the transaction.\r\n\"settlementStatus\" - Status of the progress of sending the settlements for the transaction.\r\n\"paymentStatus\" - Status of the progress of sending the payments for the transaction.\r\n\"queriedPayments\" - Number of payments within the transaction that have been queried.\r\n\"failureStatusType\" - Status of the result for the payment load and validation of the transaction.\r\n\"reasonsForFailure\" - List of reasons the payment load wasn't successful.\r\n\"transactionId\" - ID of the transaction.","type":"object","properties":{"dateUploaded":{"type":"string"},"transactionName":{"type":"string"},"transactionReference":{"type":"string"},"transactionStatus":{"format":"int32","description":"\n0 = NotSet\n1 = Validating\n2 = Failed\n3 = NotApproved\n4 = Approved\n5 = Completed\n6 = Uploading\n7 = Deleted\n8 = PleaseWait","enum":[0,1,2,3,4,5,6,7,8],"type":"integer"},"transactionStatusText":{"type":"string","readOnly":true},"uploadedBy":{"type":"string"},"approvedBy":{"type":"string"},"numberOfPayments":{"format":"int32","type":"integer"},"settlementStatus":{"type":"string"},"paymentStatus":{"type":"string"},"queriedPayments":{"format":"int32","type":"integer"},"failureStatusType":{"type":"string"},"reasonsForFailure":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"transactionId":{"format":"int32","type":"integer"}}},"PaymentList":{"description":"\"accountId\" - ID of the account.\r\n\"payments\" - List of payments to load.","type":"object","properties":{"accountId":{"format":"int32","type":"integer"},"payments":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Payment"}}},"example":{"accountId":112186376,"payments":[{"settlementCurrency":"USD","targetPaymentDate":"2018-12-04","paymentCurrency":"GBP","amount":"1100","amountType":1,"clientUniqueReference":"1236345","recipientBankCountryCode":"US","recipientName":"Leah McWilliams","recipientEmail":"test@example.com","recipientAddress1":"4 Apple Street","recipientAddress2":"","recipientAddressCountryCode":"US","recipientAccountNumberIBAN":"1231231234","recipientBIC":"BOFAUS3N","recipientNationalClearingCode":"","recipientBankName":"Bank Name","recipientBankAddress1":"100 North Tryon Street","recipientBankAddress2":"Charlotte","recipientBankAddress3":"","clientPaymentReference":"Monthly Contract Pay 743001","intermediaryBankName":"","intermediaryBankAddress1":"","intermediaryBankAddress2":"","intermediaryBankAddress3":"","intermediaryBankCountryCode":"","intermediaryAccountNumberIBAN":"","intermediaryBIC":"","intermediaryNationalClearingCode":"","reasonForPayment":"Contract Payment"}]}},"Payment":{"description":"SWIFT character only fields must match the regular expression: ^[\\r\\n\\sa-zA-Z0-9\\/\\-:,'\\?\\(\\)\\.\\+]*$\r\n\r\n\"settlementCurrency\" - 3 characters. ISO code for the required settlement currency.\r\n\"clientUniqueReference\" - Optional: up to 35 characters. Client's reference for a transaction. SWIFT characters only.\r\n\"targetPaymentDate\" - Date that the payment should credit the recipient, expressed as yyyy-MM-dd.\r\n\"paymentCurrency\" - 3 characters. ISO code of the required payment currency.\r\n\"amount\" - Required (payment/settlement) amount.\r\n\"recipientBankCountryCode\" - 2 characters. ISO code for the country of the recipient's bank.\r\n\"recipientName\" - Up to 70 characters. Name of the recipient as it is on the bank account. SWIFT characters only.\r\n\"recipientEmail\" - Optional: up to 70 characters. Email address of the recipient, if they require an individual payment confirmation.\r\n\"recipientAddress1\" - Optional: up to 35 characters. First line of the recipient's address. SWIFT characters only.\r\n\"recipientAddress2\" - Optional: up to 35 characters. Second line of the recipient's address. SWIFT characters only.\r\n\"recipientAddressCountryCode\" - Optional: 2 characters. ISO code for the country of the recipient's address.\r\n\"recipientAccountNumberIban\" - Up to 34 characters. Account number or IBAN for the recipient's bank account. SWIFT characters only.\r\n\"recipientBic\" - 8 or 11 characters. BIC of the recipient's bank. SWIFT characters only.\r\n\"recipientNationalClearingCode\" - Up to 13 characters. National clearing code of the recipient's bank. SWIFT characters only.\r\n\"recipientBankName\" - Up to 35 characters. Name of the recipient's bank. SWIFT characters only.\r\n\"recipientBankAddress1\" - Up to 35 characters. First line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"recipientBankAddress2\" - Up to 35 characters. Second line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"recipientBankAddress3\" - Up to 35 characters. Third line of the address for the recipient’s bank account. SWIFT characters only.\r\n\"clientPaymentReference\" - Up to 70 characters. Additional reference that is included in the payment details sent to the bank. SWIFT characters only.\r\n\"intermediaryBankName\" - Optional: up to 35 characters. Name of any intermediary bank. SWIFT characters only.\r\n\"intermediaryBankAddress1\" - Optional: up to 35 characters. First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankAddress2\" - Optional: up to 35 characters. First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankAddress3\" - Optional: up to 35 characters. First line of the address for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBankCountryCode\" - Optional: 2 characters. ISO code for the country of any intermediary bank account.\r\n\"intermediaryAccountNumberIban\" - Optional: up to 34 characters. Account number or IBAN for any intermediary bank account. SWIFT characters only.\r\n\"intermediaryBic\" - Optional: 8 or 11 characters. BIC of any intermediary bank account. SWIFT characters only.\r\n\"intermediaryNationalClearingCode\" - Optional: up to 13 characters. National clearing code of any intermediary bank account. SWIFT characters only.\r\n\"reasonForPayment\" - Up to 35 characters. Reason for making the payment. SWIFT characters only.\r\n\"amountType\" - Fixed payment amount or fixed settlement amount.","type":"object","properties":{"settlementCurrency":{"type":"string"},"targetPaymentDate":{"type":"string"},"paymentCurrency":{"type":"string"},"amount":{"type":"string"},"amountType":{"format":"int32","description":"\n0 = NotSet\n1 = FixedPayment\n2 = FixedSettlement","enum":[0,1,2],"type":"integer"},"clientUniqueReference":{"type":"string"},"recipientBankCountryCode":{"type":"string"},"recipientName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientAddress1":{"type":"string"},"recipientAddress2":{"type":"string"},"recipientAddressCountryCode":{"type":"string"},"recipientAccountNumberIBAN":{"type":"string"},"recipientBIC":{"type":"string"},"recipientNationalClearingCode":{"type":"string"},"recipientBankName":{"type":"string"},"recipientBankAddress1":{"type":"string"},"recipientBankAddress2":{"type":"string"},"recipientBankAddress3":{"type":"string"},"clientPaymentReference":{"type":"string"},"intermediaryBankName":{"type":"string"},"intermediaryBankAddress1":{"type":"string"},"intermediaryBankAddress2":{"type":"string"},"intermediaryBankAddress3":{"type":"string"},"intermediaryBankCountryCode":{"type":"string"},"intermediaryAccountNumberIBAN":{"type":"string"},"intermediaryBIC":{"type":"string"},"intermediaryNationalClearingCode":{"type":"string"},"reasonForPayment":{"type":"string"}}},"PaymentListResponse":{"description":"\"accountId\" - ID of the account.\r\n\"payments\" - List of payments that failed validation and reasons why.\r\n\"status\" - Enum value of the status returned from loading the payments.\r\n\"statusText\" - Text value of the status returned from loading the payments.\r\n\"transactionId\" - ID of the new transaction if loading the payments was successful.","type":"object","properties":{"accountId":{"format":"int32","type":"integer"},"payments":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/PaymentValidationResponse"}},"status":{"format":"int32","description":"\n0 = NotSet\n1 = Processing\n2 = InvalidType\n3 = ExceededMaxUploadCount\n4 = InvalidFileSize\n5 = ValidationFailed","enum":[0,1,2,3,4,5],"type":"integer"},"statusText":{"type":"string","readOnly":true},"transactionId":{"format":"int32","type":"integer"}}},"PaymentValidationResponse":{"description":"\"validationResponse\" - List of validation errors for an individual payment.","type":"object","properties":{"validationResponse":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"settlementCurrency":{"type":"string"},"targetPaymentDate":{"type":"string"},"paymentCurrency":{"type":"string"},"amount":{"type":"string"},"amountType":{"format":"int32","description":"\n0 = NotSet\n1 = FixedPayment\n2 = FixedSettlement","enum":[0,1,2],"type":"integer"},"clientUniqueReference":{"type":"string"},"recipientBankCountryCode":{"type":"string"},"recipientName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientAddress1":{"type":"string"},"recipientAddress2":{"type":"string"},"recipientAddressCountryCode":{"type":"string"},"recipientAccountNumberIBAN":{"type":"string"},"recipientBIC":{"type":"string"},"recipientNationalClearingCode":{"type":"string"},"recipientBankName":{"type":"string"},"recipientBankAddress1":{"type":"string"},"recipientBankAddress2":{"type":"string"},"recipientBankAddress3":{"type":"string"},"clientPaymentReference":{"type":"string"},"intermediaryBankName":{"type":"string"},"intermediaryBankAddress1":{"type":"string"},"intermediaryBankAddress2":{"type":"string"},"intermediaryBankAddress3":{"type":"string"},"intermediaryBankCountryCode":{"type":"string"},"intermediaryAccountNumberIBAN":{"type":"string"},"intermediaryBIC":{"type":"string"},"intermediaryNationalClearingCode":{"type":"string"},"reasonForPayment":{"type":"string"}}},"GetTransactionResponse":{"description":"\"status\" - Enum value of the status returned from getting the transaction.\r\n\"statusText\" - Text value of the status returned from getting the transaction.\r\n\"transaction\" - Details of the transaction.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = TransactionNotFound\n2 = UnableToGetCurrentSettlementInfo","enum":[0,1,2],"type":"integer"},"statusText":{"type":"string","readOnly":true},"transaction":{"$ref":"#/definitions/TransactionItem"}}},"TransactionItem":{"description":"\"transactionName\" - Name of the transaction.\r\n\"accountId\" - ID of the account for the transaction.\r\n\"transactionId\" - ID of the transaction.\r\n\"transactionReference\" - Reference of the transaction.\r\n\"transactionStatus\" - Enum value of the status returned from getting the transaction.\r\n\"transactionStatusText\" - Text value of the status returned from getting the transaction.\r\n\"dateUploaded\" - yyyy-MM-dd: Date that the transaction was uploaded.\r\n\"uploadedBy\" - Name of the person who uploaded the transaction.\r\n\"approved\" - Whether a quote has been approved for the transaction.\r\n\"dateApproved\" - yyyy-MM-dd: Date that the quote for the transaction was approved.\r\n\"approvedBy\" - Name of the person who approved the quote for the transaction.\r\n\"settlementStatus\" - Status of the progress of sending the settlements for the transaction.\r\n\"paymentStatus\" - Status of the progress of sending the payments for the transaction.\r\n\"numberOfPayments\" - Number of payments for the transaction.\r\n\"queriedPayments\" - Number of payments within the transaction that have been queried.\r\n\"includedQueriedPayments\" - Number of payments within the transaction that are included in the query.\r\n\"rejectedPayments\" - Number of payments within the transaction that have been rejected.\r\n\"excludedPayments\" - Number of payments within the transaction that have been excluded.\r\n\"approvedPayments\" - Number of payments within the transaction that have a quote approved for them.\r\n\"sentPayments\" - Number of payments within the transaction that have been sent.\r\n\"reasonsForFailure\" - List of reasons the payment load wasn't successful.\r\n\"failureStatusType\" - Status of the result for the payment load and validation of the transaction.\r\n\"canQuote\" - Whether the transaction is able to be quoted.\r\n\"canDelete\" - Whether the transaction is able to be deleted.","type":"object","properties":{"transactionName":{"type":"string"},"accountId":{"format":"int32","type":"integer"},"transactionId":{"format":"int32","type":"integer"},"transactionReference":{"type":"string"},"transactionStatus":{"format":"int32","description":"\n0 = NotSet\n1 = Validating\n2 = Failed\n3 = NotApproved\n4 = Approved\n5 = Completed\n6 = Uploading\n7 = Deleted\n8 = PleaseWait","enum":[0,1,2,3,4,5,6,7,8],"type":"integer"},"transactionStatusText":{"type":"string","readOnly":true},"dateUploaded":{"type":"string"},"uploadedBy":{"type":"string"},"approved":{"type":"boolean"},"dateApproved":{"type":"string"},"approvedBy":{"type":"string"},"settlementStatus":{"type":"string"},"paymentStatus":{"type":"string"},"numberOfPayments":{"format":"int32","type":"integer"},"queriedPayments":{"format":"int32","type":"integer"},"includedQueriedPayments":{"format":"int32","type":"integer"},"rejectedPayments":{"format":"int32","type":"integer"},"excludedPayments":{"format":"int32","type":"integer"},"approvedPayments":{"format":"int32","type":"integer"},"sentPayments":{"format":"int32","type":"integer"},"reasonsForFailure":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"failureStatusType":{"type":"string"},"canQuote":{"type":"boolean"},"canDelete":{"type":"boolean"}}},"DeleteTransactionResponse":{"description":"\"status\" - Enum value of the status returned from deleting the transaction.\r\n\"statusText\" - Text value of the status returned from deleting the transaction.","type":"object","properties":{"status":{"format":"int32","description":"\n0 = Success\n1 = TransactionNotFound\n2 = TransactionApproved","enum":[0,1,2],"type":"integer"},"statusText":{"type":"string","readOnly":true}}}}}