0-readme.md

JSON shown in here shows what the attachment in the update payload the receiving FI posts to the sending FI about a specific transaction. The fields of the JSON may have these keys:

• transaction_id: Stellar transaction ID that triggered this. This is how the sending FI knows what transaction the receiving FI is referring to.
• tx_status
  • describes the status of the transaction
  • possible values:
    • awaiting_payment: waiting for Stellar payment
    • processing: attempting to deposit
    • delay: encountered issues but may be resolved manually, please stand by
    • error: could not deposit
    • pickup_ready: can be picked up (for cash pick-ups)
    • complete: deposited or picked up
• tx_message: free form string description of the status. May include reasons for error or delay, if available.
• tracking_number: if cash needs to be picked up and a tracking number or code needs to be presented by the recipient

1-bank-deposit-error-example.json

{
  "transaction_id": "opid",
  "tx_status": "error",
  "tx_message": "Account not found"
}

2-cash-pickup-example.json

{
  "transaction_id": "opid",
  "tx_status": "pickup_ready",
  "tx_message": "Ready for pickup",
  "tracking_number": "PL69T4"
}