From 0274e70af8d619bc0ebd20a405017d04f589bc63 Mon Sep 17 00:00:00 2001 From: Jeremy Klein Date: Thu, 27 Nov 2025 01:03:31 -0800 Subject: [PATCH] Make paymentInstructions a list on OutgoingTransactions --- README.md | 34 +++++++++++-------- mintlify/global-p2p/quickstart.mdx | 14 ++++++-- mintlify/openapi.yaml | 15 ++++++-- mintlify/ramps/quickstart.mdx | 15 ++++++-- openapi.yaml | 15 ++++++-- .../transactions/OutgoingTransaction.yaml | 15 ++++++-- 6 files changed, 83 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e2855d8..2c9b1e7 100644 --- a/README.md +++ b/README.md @@ -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" + } } - } + ] } ``` @@ -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" } diff --git a/mintlify/global-p2p/quickstart.mdx b/mintlify/global-p2p/quickstart.mdx index cb1104b..7a291c0 100644 --- a/mintlify/global-p2p/quickstart.mdx +++ b/mintlify/global-p2p/quickstart.mdx @@ -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", diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index a4ce620..6bfb34a 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -5839,8 +5839,19 @@ components: description: ID of the original transaction that this transaction is retrying, if applicable example: Transaction:019542f5-b3e7-1d02-0000-000000000003 paymentInstructions: - $ref: '#/components/schemas/PaymentInstructions' - 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: '#/components/schemas/PaymentInstructions' + example: + - accountType: US_ACCOUNT + accountNumber: '1234567890' + routingNumber: '021000021' + bankName: Chase Bank + referenceCode: REF123456 + - accountType: SPARK_WALLET + address: spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu + invoice: lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs refund: $ref: '#/components/schemas/Refund' description: The refund if transaction was refunded. diff --git a/mintlify/ramps/quickstart.mdx b/mintlify/ramps/quickstart.mdx index 1e98009..68b1a94 100644 --- a/mintlify/ramps/quickstart.mdx +++ b/mintlify/ramps/quickstart.mdx @@ -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", diff --git a/openapi.yaml b/openapi.yaml index a4ce620..6bfb34a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5839,8 +5839,19 @@ components: description: ID of the original transaction that this transaction is retrying, if applicable example: Transaction:019542f5-b3e7-1d02-0000-000000000003 paymentInstructions: - $ref: '#/components/schemas/PaymentInstructions' - 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: '#/components/schemas/PaymentInstructions' + example: + - accountType: US_ACCOUNT + accountNumber: '1234567890' + routingNumber: '021000021' + bankName: Chase Bank + referenceCode: REF123456 + - accountType: SPARK_WALLET + address: spark1pgssyuuuhnrrdjswal5c3s3rafw9w3y5dd4cjy3duxlf7hjzkp0rqx6dj6mrhu + invoice: lnbc15u1p3xnhl2pp5jptserfk3zk4qy42tlucycrfwxhydvlemu9pqr93tuzlv9cc7g3sdqsvfhkcap3xyhx7un8cqzpgxqzjcsp5f8c52y2stc300gl6s4xswtjpc37hrnnr3c9wvtgjfuvqmpm35evq9qyyssqy4lgd8tj637qcjp05rdpxxykjenthxftej7a2zzmwrmrl70fyj9hvj0rewhzj7jfyuwkwcg9g2jpwtk3wkjtwnkdks84hsnu8xps5vsq4gj5hs refund: $ref: '#/components/schemas/Refund' description: The refund if transaction was refunded. diff --git a/openapi/components/schemas/transactions/OutgoingTransaction.yaml b/openapi/components/schemas/transactions/OutgoingTransaction.yaml index ae6db12..876b85b 100644 --- a/openapi/components/schemas/transactions/OutgoingTransaction.yaml +++ b/openapi/components/schemas/transactions/OutgoingTransaction.yaml @@ -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.