Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 53 additions & 18 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions mintlify/payouts-and-b2b/payment-flow/send-payment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/transfer-out' \
`remittanceInformation` is optional. Use it to send a reference that travels with the payment to the recipient (max 80 characters). This populates the ACH Addenda record, FedNow/RTP remittance information, or wire OBI field depending on the payment rail.
</Info>

<Info>
`purposeOfPayment` is optional and accepts the same values as on a quote. Some destinations
require it, and some rails carry it on the payment itself.
</Info>


```json Success (201 Created)
{
Expand Down
6 changes: 6 additions & 0 deletions mintlify/snippets/external-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers/external-acco
<Note>
Category must be `CHECKING` or `SAVINGS`. Routing number must be 9 digits.
</Note>

<Note>
Three further fields apply to the `WIRE` rail and are ignored on ACH, RTP and FedNow:
`intermediaryBankName` and `intermediaryRoutingNumber`, for a beneficiary bank reachable only
through a correspondent, and `fiToFiInformation` for bank-to-bank instructions.
</Note>
</Tab>

<Tab title="Mexico">
Expand Down
71 changes: 53 additions & 18 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions openapi/components/schemas/common/UsdAccountInfoBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,47 @@ properties:
minLength: 9
maxLength: 9
pattern: ^[0-9]{9}$
bankName:
type: string
description: The name of the financial institution holding the account
example: Chase Bank
minLength: 1
maxLength: 140
bankAccountType:
type: string
description: Whether the account is a checking or a savings account
enum:
- CHECKING
- SAVINGS
example: CHECKING
intermediaryBankName:
type: string
description: >-
The name of the intermediary financial institution, for accounts reachable
only through a correspondent bank. Used on the WIRE rail; ignored on ACH,
RTP and FEDNOW.
example: JPMorgan Chase Bank
minLength: 1
maxLength: 140
intermediaryRoutingNumber:
type: string
description: >-
The ABA routing number of the intermediary financial institution. Used on
the WIRE rail; ignored on ACH, RTP and FEDNOW.
example: '021000021'
minLength: 9
maxLength: 9
pattern: ^[0-9]{9}$
fiToFiInformation:
type: string
description: >-
Bank-to-bank instructions carried alongside the payment. Used on the WIRE
rail; ignored on ACH, RTP and FEDNOW.
example: /BNF/Invoice 4471
maxLength: 210
example:
accountType: USD_ACCOUNT
accountNumber: '1234567890'
routingNumber: '021000021'
bankName: Chase Bank
bankAccountType: CHECKING
2 changes: 2 additions & 0 deletions openapi/components/schemas/transfers/TransferOutRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ properties:
remittanceInformation field, and for wires it populates the OBI
(Originator to Beneficiary Information) / beneficiary information.
example: '12345'
purposeOfPayment:
$ref: ../quotes/PurposeOfPayment.yaml
Loading