Changes to Get Payments for Payout

added the optional property content/items/transmissionTypeRequested to the response with the 200 status

added the optional property content/items/railsAccountId to the response with the 200 status

added the optional property content/items/railsRejectionInformation to the response with the 200 status

added the optional property content/items/transactionId to the response with the 200 status

added the optional property content/items/transactionReference to the response with the 200 status

added the new optional query request parameter railsId

added the optional property content/items/postInstructFxInfo to the response with the 200 status

added the new enum value GACHO to the query request parameter transmissionType

added the new enum value LOCAL to the query request parameter transmissionType

added the optional property content/items/paymentScheme to the response with the 200 status

removed the ACCEPTED enum value from the content/items/status response property for the response status 200

removed the ACCEPTED enum value from the summary/payoutStatus response property for the response status 200

removed the ACCEPTED_BY_RAILS enum value from the content/items/status response property for the response status 200

removed the ACH_PAYMENT_RETURN_CANCELLED enum value from the content/items/events/items/eventType response property for the response status 200

removed the ACH_RETURN_RECEIVED enum value from the content/items/events/items/eventType response property for the response status 200

removed the ACH_SUBMITTED_TO_ODFI enum value from the content/items/events/items/eventType response property for the response status 200

removed the AS enum value from the summary/payoutType response property for the response status 200

removed the AWAITING_FUNDS enum value from the content/items/status response property for the response status 200

removed the BANK_PAYMENT_REQUESTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the BANK_PAYMENT_REQUESTED enum value from the content/items/status response property for the response status 200

removed the COMPLETED enum value from the summary/payoutStatus response property for the response status 200

removed the CONFIRMED enum value from the content/items/status response property for the response status 200

removed the CONFIRMED enum value from the summary/payoutStatus response property for the response status 200

removed the EUR enum value from the content/items/events/items/paymentCurrency response property for the response status 200

removed the EUR enum value from the content/items/events/items/sourceCurrency response property for the response status 200

removed the EUR enum value from the content/items/paymentCurrency response property for the response status 200

removed the EUR enum value from the content/items/sourceCurrency response property for the response status 200

removed the EXECUTED enum value from the content/items/schedule/scheduleStatus response property for the response status 200

removed the EXECUTED enum value from the summary/schedule/scheduleStatus response property for the response status 200

removed the FAILED enum value from the content/items/schedule/scheduleStatus response property for the response status 200

removed the FAILED enum value from the summary/schedule/scheduleStatus response property for the response status 200

removed the FUNDED enum value from the content/items/fundingStatus response property for the response status 200

removed the FUNDED enum value from the content/items/status response property for the response status 200

removed the GBP enum value from the content/items/events/items/paymentCurrency response property for the response status 200

removed the GBP enum value from the content/items/events/items/sourceCurrency response property for the response status 200

removed the GBP enum value from the content/items/paymentCurrency response property for the response status 200

removed the GBP enum value from the content/items/sourceCurrency response property for the response status 200

removed the INCOMPLETE enum value from the summary/payoutStatus response property for the response status 200

removed the INSTRUCTED enum value from the content/items/fundingStatus response property for the response status 200

removed the INSTRUCTED enum value from the summary/payoutStatus response property for the response status 200

removed the ON_BEHALF_OF enum value from the summary/payoutType response property for the response status 200

removed the ORCHESTRATED_PAYMENT_BATCH_CONFIRMED enum value from the content/items/events/items/eventType response property for the response status 200

removed the ORCHESTRATED_PAYMENT_BATCH_REQUESTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the ORCHESTRATED_PAYMENT_REQUESTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_ACCEPTED_BY_RAILS enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_AWAITING_FUNDS enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_CONFIRMED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_FAILED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_FUNDED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_SUBMITTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_SUBMITTED_ACCEPTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_SUBMITTED_REJECTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYMENT_UNFUNDED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_EXECUTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_FUNDED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_FUNDS_RETURNED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_QUOTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_BATCH_QUOTE_EXPIRED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_COMPLETED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_FUNDS_DENIED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_FUNDS_GRANTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_FUNDS_REQUEST enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_INSTRUCTED_V3 enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_QUOTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_SUBMITTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the PAYOUT_WITHDRAWN enum value from the content/items/events/items/eventType response property for the response status 200

removed the QUOTED enum value from the summary/payoutStatus response property for the response status 200

removed the REJECTED enum value from the content/items/status response property for the response status 200

removed the REJECTED enum value from the summary/payoutStatus response property for the response status 200

removed the RETURNED enum value from the content/items/status response property for the response status 200

removed the RETURN_PAYMENT_CANCELLATION_REQUESTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the RETURN_PAYMENT_FUNDING_REQUESTED enum value from the content/items/events/items/eventType response property for the response status 200

removed the SCHEDULED enum value from the content/items/schedule/scheduleStatus response property for the response status 200

removed the SCHEDULED enum value from the summary/schedule/scheduleStatus response property for the response status 200

removed the SOURCE_AMOUNT_CONFIRMED enum value from the content/items/events/items/eventType response property for the response status 200

removed the STANDARD enum value from the summary/payoutType response property for the response status 200

removed the SUBMITTED enum value from the summary/payoutStatus response property for the response status 200

removed the UNFUNDED enum value from the content/items/fundingStatus response property for the response status 200

removed the UNFUNDED enum value from the content/items/status response property for the response status 200

removed the USD enum value from the content/items/events/items/paymentCurrency response property for the response status 200

removed the USD enum value from the content/items/events/items/sourceCurrency response property for the response status 200

removed the USD enum value from the content/items/paymentCurrency response property for the response status 200

removed the USD enum value from the content/items/sourceCurrency response property for the response status 200

removed the WITHDRAWN enum value from the content/items/status response property for the response status 200

removed the WITHDRAWN enum value from the summary/payoutStatus response property for the response status 200

added the optional property content/items/payeeAddressCountryCode to the response with the 200 status

added the optional property content/items/events/items/scheduledAt to the response with the 200 status

added the optional property content/items/events/items/scheduledBy to the response with the 200 status

added the optional property content/items/events/items/scheduledFor to the response with the 200 status

added the optional property content/items/autoWithdrawnReasonCode to the response with the 200 status

added the optional property content/items/schedule to the response with the 200 status

added the optional property summary/schedule to the response with the 200 status

added the new ORCHESTRATED_PAYMENT_BATCH_CONFIRMED enum value to the content/items/events/items/eventType response property for the response status 200

added the new ORCHESTRATED_PAYMENT_BATCH_REQUESTED enum value to the content/items/events/items/eventType response property for the response status 200

added the new ORCHESTRATED_PAYMENT_REQUESTED enum value to the content/items/events/items/eventType response property for the response status 200

added the new optional query request parameter remoteSystemId

added the optional property content/items/paymentMetadata to the response with the 200 status

added the optional property content/items/paymentTrackingReference to the response with the 200 status

added the optional property content/items/remoteSystemId to the response with the 200 status

added the optional property content/items/remoteSystemPaymentId to the response with the 200 status

the errors/items response's property type changed from no type to object for status 400

the errors/items response's property type changed from no type to object for status 401

the errors/items response's property type changed from no type to object for status 403

the errors/items response's property type changed from no type to object for status 404

added the new optional query request parameter transmissionType

added the optional property content/items/transmissionType to the response with the 200 status

added the optional property errors/items/errorCode to the response with the 400 status

added the optional property errors/items/errorCode to the response with the 401 status

added the optional property errors/items/errorCode to the response with the 403 status

added the optional property errors/items/errorCode to the response with the 404 status

added the optional property errors/items/errorData to the response with the 400 status

added the optional property errors/items/errorData to the response with the 401 status

added the optional property errors/items/errorData to the response with the 403 status

added the optional property errors/items/errorData to the response with the 404 status

added the optional property errors/items/localisationDetails to the response with the 400 status

added the optional property errors/items/localisationDetails to the response with the 401 status

added the optional property errors/items/localisationDetails to the response with the 403 status

added the optional property errors/items/localisationDetails to the response with the 404 status

added the optional property httpStatusCode to the response with the 400 status

added the optional property httpStatusCode to the response with the 401 status

added the optional property httpStatusCode to the response with the 403 status

added the optional property httpStatusCode to the response with the 404 status

response property errors/items/locationType deprecated

response property errors/items/locationType deprecated

response property errors/items/locationType deprecated

response property errors/items/locationType deprecated

response property errors/items/reasonCode deprecated

response property errors/items/reasonCode deprecated

response property errors/items/reasonCode deprecated

response property errors/items/reasonCode deprecated

for the query request parameter pageSize, the max was set to 100.00

for the query request parameter pageSize, the min was set to 1.00

api tag Payout History removed

added the media type application/json for the response with the status 400

added the media type application/json for the response with the status 401

added the media type application/json for the response with the status 403

added the media type application/json for the response with the status 404

added the optional property content/items/isPaymentCcyBaseCcy to the response with the 200 status

added the optional property content/items/withdrawable to the response with the 200 status

added the optional property content/items/withdrawnReason to the response with the 200 status

added the optional property summary/withdrawnPayments to the response with the 200 status

the response property content/items/payout/payoutFrom became optional for the status 200

the response property content/items/payout/payoutTo became optional for the status 200

the content/items/payout response's property type changed from object to no type for status 200

added the optional property content/items/payout/payoutId to the response with the 200 status

the content/items/payout response's property type changed from no type to object for status 200

added the non-success response with the status 401

added the non-success response with the status 403

added the optional property content/items/railsBatchId to the response with the 200 status

added the optional property content/items/railsPaymentId to the response with the 200 status

added the optional property content/items/rejectionReason to the response with the 200 status

added the optional property summary/withdrawnDateTime to the response with the 200 status

the response property content/items/payout/payoutFrom became required for the status 200

the response property content/items/payout/payoutTo became required for the status 200

the railsId response's property default value RAILS ID UNAVAILABLE was added for the status 200

response property content/items/payorId reactivated

added the optional property content/items/payout to the response with the 200 status

added the optional property summary/instructed to the response with the 200 status

added the optional property summary/payoutFrom to the response with the 200 status

added the optional property summary/payoutTo to the response with the 200 status

added the optional property summary/payoutType to the response with the 200 status

added the optional property summary/quoted to the response with the 200 status

added the optional property summary/quotedDateTime to the response with the 200 status

added the optional property summary/submitting to the response with the 200 status

added the optional property summary/withdrawn to the response with the 200 status

response property content/items/payorId deprecated

the content/items/events/items/paymentAmount response's property format changed from int32 to int64 for status 200

the content/items/events/items/sourceAmount response's property format changed from int32 to int64 for status 200

endpoint added