Skip to content

Make paymentInstructions a list on OutgoingTransactions #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 28, 2025
Merged

Make paymentInstructions a list on OutgoingTransactions #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 20 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,14 +245,18 @@ Response:
"FULL_NAME": "Jane Receiver",
"BIRTH_DATE": "1990-01-01"
},
"paymentInstructions": {
"reference": "UMA-Q12345-REF",
"bankAccountInfo": {
"accountType": "CLABE",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico"
"paymentInstructions": [
{
"instructionsNotes": "Include reference code in transfer memo",
"accountOrWalletInfo": {
"accountType": "US_ACCOUNT",
"accountNumber": "1234567890",
"routingNumber": "021000021",
"bankName": "Chase Bank",
"referenceCode": "REF123456"
}
}
}
]
}
```

Expand Down Expand Up @@ -294,14 +298,16 @@ Response:
"FULL_NAME": "Jane Receiver",
"BIRTH_DATE": "1990-01-01"
},
"paymentInstructions": {
"reference": "UMA-Q12345-REF",
"bankAccountInfo": {
"accountType": "CLABE",
"clabeNumber": "123456789012345678",
"bankName": "BBVA Mexico"
"paymentInstructions": [{
"instructionsNotes": "Include reference code in transfer memo",
"accountOrWalletInfo": {
"accountType": "US_ACCOUNT",
"accountNumber": "1234567890",
"routingNumber": "021000021",
"bankName": "Chase Bank",
"referenceCode": "REF123456"
}
},
}],
"status": "COMPLETED",
"transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000005"
}
Expand Down
14 changes: 12 additions & 2 deletions mintlify/global-p2p/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,18 @@ In this guide, the entities map as follows:
"receivedAmount": { "amount": 9706, "currency": { "code": "MXN", "decimals": 2 } },
"customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
"paymentInstructions": {
"reference": "UMA-Q12345-REF"
"paymentInstructions": [
{
"instructionsNotes": "Include reference code in transfer memo",
"accountOrWalletInfo": {
"accountType": "US_ACCOUNT",
"accountNumber": "1234567890",
"routingNumber": "021000021",
"bankName": "Chase Bank",
"referenceCode": "REF123456"
}
},
]
}
},
"timestamp": "2025-01-15T14:32:00Z",
Expand Down
15 changes: 13 additions & 2 deletions mintlify/openapi.yaml
View file
Open in desktop

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

15 changes: 12 additions & 3 deletions mintlify/ramps/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,18 @@ Once Grid receives your payment and completes the USD-to-BTC conversion and deli
"description": "On-ramp: Buy $100 of Bitcoin",
"exchangeRate": 8.3333,
"quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
"paymentInstructions": {
"reference": "RAMP-ABC123"
}
"paymentInstructions": [
{
"instructionsNotes": "Include reference code in transfer memo",
"accountOrWalletInfo": {
"accountType": "US_ACCOUNT",
"accountNumber": "1234567890",
"routingNumber": "021000021",
"bankName": "Chase Bank",
"referenceCode": "REF123456"
}
}
]
},
"timestamp": "2025-10-03T15:03:00Z",
"webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000030",
Expand Down
15 changes: 13 additions & 2 deletions openapi.yaml
View file
Open in desktop

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

15 changes: 13 additions & 2 deletions openapi/components/schemas/transactions/OutgoingTransaction.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,19 @@ allOf:
ID of the original transaction that this transaction is retrying, if applicable
example: Transaction:019542f5-b3e7-1d02-0000-000000000003
paymentInstructions:
$ref: ../common/PaymentInstructions.yaml
description: Contains the reference code, banking details, and instructions needed to complete the payment
type: array
description: Payment instructions for executing the payment.
items:
$ref: ../common/PaymentInstructions.yaml
example:
- accountType: US_ACCOUNT
accountNumber: "1234567890"
routingNumber: "021000021"
bankName: "Chase Bank"
referenceCode: "REF123456"
- accountType: SPARK_WALLET
address: "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu"
invoice: "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
refund:
$ref: ../common/Refund.yaml
description: The refund if transaction was refunded.
Expand Down