Transactions & Responses
Sends a payin message
Sends a new payin transaction, requesting or expecting an incoming payment. If the transaction request/expectaton is successful, it will end up moving funds from an account on a external network (e.g: traditional bank accounts) to an account of a participant of the Shinkansen network.
post/messages/payins
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"
}
},
"transactions": [
{
"transaction_type": "payin",
"payin_type": "interactive_payment",
"interactive_payment_success_redirect_url": "https://example.org/payments/success",
"interactive_payment_failure_redirect_url": "https://example.org/payments/failure",
"transaction_id": "11fe7135-750a-47e2-93cd-60f24f526351",
"currency": "CLP",
"amount": "20000",
"expiration_date": "2023-04-11T10:30:00-03:00",
"description": "Wallet top-up",
"debtor": {
"name": "Medium Retail S.A",
"identification": {
"id_schema": "CLID",
"id": "12383287-6"
},
"email": "tesoreria@example.org"
},
"creditor": {
"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"
}
},
{
"transaction_type": "payin",
"payin_type": "expected_payment",
"metadata": {
"reference": "1234567890"
},
"transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c",
"currency": "CLP",
"amount": "30000",
"expiration_date": "2023-04-30T10:30:00-03:00",
"description": "Bulk salary funding expected via TEF",
"debtor": {
"name": "Medium Retail S.A",
"identification": {
"id_schema": "CLID",
"id": "12383287-6"
},
"financial_institution": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "SCOTIABANK_CL"
},
"account": "1513523451",
"account_type": "current_account",
"email": "tesoreria@example.org"
},
"creditor": {
"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"
}
}
]
}
}Response
Message correctly received. Does NOT mean the transaction was succesful. Transaction result is communicated back via webhook. Includes the transaction's shinkansen_ids and urls for any transactions of interactive_payment type.
Example response
{
"transactions": [
{
"transaction_id": "c5bae6b3-7c11-4b09-aad8-340ecc1a042c",
"shinkansen_transaction_id": "a517a741-e84f-4ac1-8d9d-922162fc703b",
"interactive_payment_url": "https://payments.shinkansen.finance/8cd07f3a5ff98f2a78cfc366c13fb123eb8d29c1ca37c79df190425d5b9e424d"
},
{
"transaction_id": "6f913677-8d84-4dae-a30d-3639608ec3f3",
"shinkansen_transaction_id": "4266ca42-b990-4f59-9b08-623660a72ee2"
}
]
}