Add counterparty delivery status to the outgoing transaction object (#241)

Author: shreyav

README.md

@@ -310,6 +310,7 @@ When the payment status changes (to completed or failed), your platform will rec
     "description": "Payment for invoice #1234",
     "exchangeRate": 0.92,
     "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
+    "counterpartyDeliveryStatus": "PENDING"
   },
   "timestamp": "2023-08-15T14:32:00Z",
   "webhookId": "Webhook:019542f5-b3e7-1d02-0000-000000000007",

docusaurus-docs/docs/sending-payments.md

@@ -253,6 +253,7 @@ When the payment status changes (to completed or failed), your platform will rec
     "description": "Payment for invoice #1234",
     "exchangeRate": 0.92,
     "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
+    "counterpartyDeliveryStatus": "PENDING",
     "paymentInstructions": {
       "reference": "UMA-Q12345-REF",
       "bankAccountInfo": {

docusaurus-docs/src/pages/sending-payments-jit.md

@@ -251,6 +251,7 @@ When the payment status changes (to completed or failed), your platform will rec
     "description": "Payment for invoice #1234",
     "exchangeRate": 0.92,
     "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
+    "counterpartyDeliveryStatus": "PENDING",
     "paymentInstructions": {
       "reference": "UMA-Q12345-REF",
       "bankAccountInfo": {

mintlify/openapi.yaml

@@ -252,6 +252,7 @@ When the payment status changes (to completed or failed), your platform will rec
     "description": "Payment for invoice #1234",
     "exchangeRate": 0.92,
     "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
+    "counterpartyDeliveryStatus": "PENDING",
     "paymentInstructions": {
       "reference": "UMA-Q12345-REF",
       "bankAccountInfo": {

mintlify/remittances/developer-guides/sending-payments.mdx

@@ -0,0 +1,8 @@
+type: string
+enum:
+  - PENDING
+  - COMPLETED
+  - FAILED
+description: >-
+  The status of the delivery of the payment from the counterparty to the end recipient.
+  This will only be present if the transaction has passed the `COMPLETED` status.

openapi.yaml

@@ -45,3 +45,6 @@ allOf:
       failureReason:
         $ref: ./OutgoingTransactionFailureReason.yaml
         description: If the transaction failed, this field provides the reason for failure.
+      counterpartyDeliveryStatus:
+        $ref: ./CounterpartyDeliveryStatus.yaml
+        description: Status of the delivery of the payment. This will only be present if the transaction has passed the `COMPLETED` status.