From c199bf21ab6e905e64ce922a7f714effe71ba126 Mon Sep 17 00:00:00 2001 From: Peng Ying Date: Tue, 2 Jun 2026 16:45:51 -0700 Subject: [PATCH] feat(transfers): add remittanceInformation to transfer-out request Add an optional remittanceInformation field (max 80 chars) to the transfer-out request body. The field this populates depends on the payment rail: ACH populates the Addenda record (max 80 chars), FedNow/RTP populate remittanceInformation (max 140 chars), and wires populate the OBI / beneficiary information (max 140 chars). Co-Authored-By: Claude Opus 4.8 (1M context) --- mintlify/openapi.yaml | 6 ++++++ openapi.yaml | 6 ++++++ .../schemas/transfers/TransferOutRequest.yaml | 10 ++++++++++ openapi/paths/transfers/transfer_out.yaml | 1 + 4 files changed, 23 insertions(+) diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 945af58f..53895d63 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -2145,6 +2145,7 @@ paths: accountId: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965 paymentRail: ACH amount: 12550 + remittanceInformation: '12345' responses: '201': description: Transfer-out request created successfully @@ -16213,6 +16214,11 @@ components: format: int64 description: Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC) example: 12550 + remittanceInformation: + type: string + maxLength: 80 + description: 'Free-form information about the payment that travels with it to the recipient. The field this populates depends on the payment rail: for ACH it populates the Addenda record, for FedNow and RTP it populates the remittanceInformation field, and for wires it populates the OBI (Originator to Beneficiary Information) / beneficiary information.' + example: '12345' CurrencyPreference: type: object required: diff --git a/openapi.yaml b/openapi.yaml index 945af58f..53895d63 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2145,6 +2145,7 @@ paths: accountId: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965 paymentRail: ACH amount: 12550 + remittanceInformation: '12345' responses: '201': description: Transfer-out request created successfully @@ -16213,6 +16214,11 @@ components: format: int64 description: Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC) example: 12550 + remittanceInformation: + type: string + maxLength: 80 + description: 'Free-form information about the payment that travels with it to the recipient. The field this populates depends on the payment rail: for ACH it populates the Addenda record, for FedNow and RTP it populates the remittanceInformation field, and for wires it populates the OBI (Originator to Beneficiary Information) / beneficiary information.' + example: '12345' CurrencyPreference: type: object required: diff --git a/openapi/components/schemas/transfers/TransferOutRequest.yaml b/openapi/components/schemas/transfers/TransferOutRequest.yaml index c6906fde..1678b407 100644 --- a/openapi/components/schemas/transfers/TransferOutRequest.yaml +++ b/openapi/components/schemas/transfers/TransferOutRequest.yaml @@ -16,3 +16,13 @@ properties: Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC) example: 12550 + remittanceInformation: + type: string + maxLength: 80 + description: >- + Free-form information about the payment that travels with it to the + recipient. The field this populates depends on the payment rail: for ACH + it populates the Addenda record, for FedNow and RTP it populates the + remittanceInformation field, and for wires it populates the OBI + (Originator to Beneficiary Information) / beneficiary information. + example: '12345' diff --git a/openapi/paths/transfers/transfer_out.yaml b/openapi/paths/transfers/transfer_out.yaml index e0afde18..60b5b36c 100644 --- a/openapi/paths/transfers/transfer_out.yaml +++ b/openapi/paths/transfers/transfer_out.yaml @@ -33,6 +33,7 @@ post: accountId: ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965 paymentRail: ACH amount: 12550 + remittanceInformation: '12345' responses: '201': description: Transfer-out request created successfully