Reversals & Responses

Send reversals

Sends a conditional reversal message, which — if accepted (by the IFR) — will cancel the original transaction You will receive the status of the reversal in your webhook (https://docs.shinkansen.tech/reference/post-response-webook_transfers).

post/reversals

Request

Base URL
https://sandbox-gateway.shinkansen.finance/api
URL
https://sandbox-gateway.shinkansen.finance/api/reversals
Auth
API key in header Shinkansen-JWS-Signature and API key in header Shinkansen-Api-Key

Request body

Example request

{
  "document": {
    "header": {
      "message_id": "014a74cb-597c-46a1-8217-63e58a336b0d",
      "creation_date": "2022-04-08T18:25:43-04:00",
      "sender": "TENPO",
      "receiver": "SHINKANSEN"
    },
    "reversals": [
      {
        "original_transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c",
        "reversal_id": "bad528bd-2a18-45d6-b221-0de05ce49f35"
      }
    ]
  }
}

Response

Message correctly received and accepted to be processed by Shinkansen Gateway and sent to Switch (CCA -> IFR)

shinkansen_message_idstring uuid required

Message ID generated by Shinkansen receiving the reversal

Example response

{
  "shinkansen_message_id": "903feb07-8a90-4e2a-ab4c-cec902903263",
  "reversals": [
    {
      "original_transaction_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
      "reversal_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
      "shinkansen_reversal_id": "a517a741-e84f-4ac1-8d9d-922162fc703b"
    },
    {
      "original_transaction_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
      "reversal_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
      "shinkansen_reversal_id": "4266ca42-b990-4f59-9b08-623660a72ee2"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.