Payout orders

Validate the signature of a payout order message

Checks that the Shinkansen-JWS-Signature header is a valid detached JWS signature for the body of the request, using the certificates registered for the sender in the document.header.sender.fin_id field. Nothing is created or modified: use it to debug a signing implementation before sending real payout orders.

post/payout_orders/validate_signature

Request

Base URL
https://api.treasury.shinkansen.finance/v1
URL
https://api.treasury.shinkansen.finance/v1/payout_orders/validate_signature
Auth
API key in header Shinkansen-Treasury-Api-Key and API key in header Shinkansen-JWS-Signature

Request body

Example request

{
  "document": {
    "header": {
      "message_id": "014a74cb-597c-46a1-8217-63e58a336b0d",
      "creation_date": "2022-04-08T18:25:43-04:00",
      "sender": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "BUK"
      },
      "receiver": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "SHINKANSEN_TREASURY"
      }
    },
    "payout_orders": [
      {
        "payout_order_id": "8af773eb-761d-44a5-86a9-1435189d215c",
        "currency": "CLP",
        "amount": "30000",
        "execution_date": "2022-04-11T10:30:00-03:00",
        "description": "Salary payment - Employee 1",
        "reference_number": "1234567",
        "tracking_key": "AAA1234567",
        "payment_purpose_category": "default",
        "payment_rail": "default",
        "execution_mode": "default",
        "po_connection": "default",
        "debtor": {
          "name": "Buk SpA",
          "identification": {
            "id_schema": "CLID",
            "id": "12383287-6"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "BANCO_BICE_CL"
          },
          "account": "123451",
          "account_type": "current_account",
          "email": "payments@buk.com"
        },
        "creditor": {
          "name": "Romulo Gallegos",
          "identification": {
            "id_schema": "CLID",
            "id": "12383287-6"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "SCOTIABANK_CL"
          },
          "account": "1513523451",
          "account_type": "current_account",
          "email": "romulo.gallegos@shinkansen.finance"
        }
      },
      {
        "payout_order_id": "9bf884fc-872e-55b6-97b0-2546290e326d",
        "currency": "CLP",
        "amount": "45000",
        "execution_date": "2022-04-11T10:30:00-03:00",
        "description": "Salary payment - Employee 2",
        "reference_number": "1234568",
        "tracking_key": "AAA1234568",
        "payment_purpose_category": "default",
        "payment_rail": "default",
        "execution_mode": "default",
        "po_connection": "default",
        "debtor": {
          "name": "Buk SpA",
          "identification": {
            "id_schema": "CLID",
            "id": "12383287-6"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "BANCO_BICE_CL"
          },
          "account": "123451",
          "account_type": "current_account",
          "email": "payments@buk.com"
        },
        "creditor": {
          "name": "Maria Garcia",
          "identification": {
            "id_schema": "CLID",
            "id": "15678432-1"
          },
          "financial_institution": {
            "fin_id_schema": "SHINKANSEN",
            "fin_id": "BANCO_ESTADO_CL"
          },
          "account": "2624634562",
          "account_type": "current_account",
          "email": "maria.garcia@example.com"
        }
      }
    ]
  },
  "batch": {
    "description": "Monthly payroll"
  }
}

Response

The signature is a valid detached JWS for the given body.

messagestring

Confirmation that the signature was validated.

Example response

{
  "message": "valid signature"
}

Changes

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