Skip to content

Commit 05db777

Browse files
authored
Make paymentInstructions a list on OutgoingTransactions (#98)
1 parent bf5d7ec commit 05db777

File tree

6 files changed

+83
-25
lines changed

6 files changed

+83
-25
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,18 @@ Response:
245245
"FULL_NAME": "Jane Receiver",
246246
"BIRTH_DATE": "1990-01-01"
247247
},
248-
"paymentInstructions": {
249-
"reference": "UMA-Q12345-REF",
250-
"bankAccountInfo": {
251-
"accountType": "CLABE",
252-
"clabeNumber": "123456789012345678",
253-
"bankName": "BBVA Mexico"
248+
"paymentInstructions": [
249+
{
250+
"instructionsNotes": "Include reference code in transfer memo",
251+
"accountOrWalletInfo": {
252+
"accountType": "US_ACCOUNT",
253+
"accountNumber": "1234567890",
254+
"routingNumber": "021000021",
255+
"bankName": "Chase Bank",
256+
"referenceCode": "REF123456"
257+
}
254258
}
255-
}
259+
]
256260
}
257261
```
258262

@@ -294,14 +298,16 @@ Response:
294298
"FULL_NAME": "Jane Receiver",
295299
"BIRTH_DATE": "1990-01-01"
296300
},
297-
"paymentInstructions": {
298-
"reference": "UMA-Q12345-REF",
299-
"bankAccountInfo": {
300-
"accountType": "CLABE",
301-
"clabeNumber": "123456789012345678",
302-
"bankName": "BBVA Mexico"
301+
"paymentInstructions": [{
302+
"instructionsNotes": "Include reference code in transfer memo",
303+
"accountOrWalletInfo": {
304+
"accountType": "US_ACCOUNT",
305+
"accountNumber": "1234567890",
306+
"routingNumber": "021000021",
307+
"bankName": "Chase Bank",
308+
"referenceCode": "REF123456"
303309
}
304-
},
310+
}],
305311
"status": "COMPLETED",
306312
"transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000005"
307313
}

mintlify/global-p2p/quickstart.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,18 @@ In this guide, the entities map as follows:
208208
"receivedAmount": { "amount": 9706, "currency": { "code": "MXN", "decimals": 2 } },
209209
"customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
210210
"quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
211-
"paymentInstructions": {
212-
"reference": "UMA-Q12345-REF"
211+
"paymentInstructions": [
212+
{
213+
"instructionsNotes": "Include reference code in transfer memo",
214+
"accountOrWalletInfo": {
215+
"accountType": "US_ACCOUNT",
216+
"accountNumber": "1234567890",
217+
"routingNumber": "021000021",
218+
"bankName": "Chase Bank",
219+
"referenceCode": "REF123456"
220+
}
221+
},
222+
]
213223
}
214224
},
215225
"timestamp": "2025-01-15T14:32:00Z",

mintlify/openapi.yaml

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mintlify/ramps/quickstart.mdx

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,18 @@ Once Grid receives your payment and completes the USD-to-BTC conversion and deli
232232
"description": "On-ramp: Buy $100 of Bitcoin",
233233
"exchangeRate": 8.3333,
234234
"quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
235-
"paymentInstructions": {
236-
"reference": "RAMP-ABC123"
237-
}
235+
"paymentInstructions": [
236+
{
237+
"instructionsNotes": "Include reference code in transfer memo",
238+
"accountOrWalletInfo": {
239+
"accountType": "US_ACCOUNT",
240+
"accountNumber": "1234567890",
241+
"routingNumber": "021000021",
242+
"bankName": "Chase Bank",
243+
"referenceCode": "REF123456"
244+
}
245+
}
246+
]
238247
},
239248
"timestamp": "2025-10-03T15:03:00Z",
240249
"webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000030",

openapi.yaml

Lines changed: 13 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/components/schemas/transactions/OutgoingTransaction.yaml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,19 @@ allOf:
3434
ID of the original transaction that this transaction is retrying, if applicable
3535
example: Transaction:019542f5-b3e7-1d02-0000-000000000003
3636
paymentInstructions:
37-
$ref: ../common/PaymentInstructions.yaml
38-
description: Contains the reference code, banking details, and instructions needed to complete the payment
37+
type: array
38+
description: Payment instructions for executing the payment.
39+
items:
40+
$ref: ../common/PaymentInstructions.yaml
41+
example:
42+
- accountType: US_ACCOUNT
43+
accountNumber: "1234567890"
44+
routingNumber: "021000021"
45+
bankName: "Chase Bank"
46+
referenceCode: "REF123456"
47+
- accountType: SPARK_WALLET
48+
address: "spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu"
49+
invoice: "lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs"
3950
refund:
4051
$ref: ../common/Refund.yaml
4152
description: The refund if transaction was refunded.

0 commit comments

Comments
 (0)