Submit a payout request
Accepts a Base64-encoded payout request in the format specified by the format path parameter.
Supported values:
pacs008for ISO 20022pacs.008.*XML messagesjsonfor a JSON payload whereentityId,beneficiaryId,amount,currency, andreferenceare all required
Authentication uses Meridian HMAC headers:
- X-Meridian-Api-Key
- X-Meridian-Timestamp
- X-Meridian-Signature
Use Idempotency-Key as a separate header for duplicate protection.
The endpoint returns 202 Accepted once the encoded payload has been safely accepted for processing. Webhooks will be sent for each status change until a finality status. The transaction APIs may be used to list resulting transactions and retrieve the latest status on demand.
Authorizations
Headers
Path Parameters
Body
Base64 string containing the full original message payload, encoded as a single opaque document.
For pacs008, the decoded payload is an ISO 20022 XML document.
For json, the decoded payload is a JSON object where entityId, beneficiaryId, amount, currency, and reference are all required.
Base64-encoded string containing the full original message payload.
20"PERvY3VtZW50IHhtbG5zPSJ1cm46aXNvOnN0ZDppc286MjAwMjI6dGVjaDp4c2Q6cGFjcy4wMDguMDAxLjA4Ij48RklUb0ZJQ3N0bXJDZHRUcmY+PEdycEhkcj48TXNnSWQ+MjAyNjA0MDctMDAwMTIzPC9Nc2dJZD48L0dycEhkcj48L0ZJVG9GSUNzdG1yQ2R0VHJmPjwvRG9jdW1lbnQ+"
Response
Message accepted for asynchronous processing