AVIS Bank API Reference
Sandbox InformationAPI endpoint:
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Initiate Nexor SessionSimilar to Initiate Session, this API generates a JWT Token, but authenticates a pre-existing and pre-verified user through the Nexor system. Like Initiate Session, a JWT is provided for use in future APIs. There is a 90 day timeout for the JWT.Bearer token JWT authentication is a specific implementation of JWT authentication that relies on the use of a "bearer" token. In this scheme, when a user logs in, the server generates a JWT token and sends it back to the client. The client then includes this token in the "Authorization" header of each subsequent request, preceded by the word "Bearer" (e.g. "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."). When the server receives the request, it extracts the token from the header and verifies its signature and expiration. If the token is valid, the server uses the information contained in the token to authorize the request.
|
POST /api/middleware/session/nexor_start
RESULT /api/middleware/session/nexor_start
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pain.001: MT101 & MT103The pain.001 message is used for initiating credit transfers and direct debits between financial institutions. The pain.001 message includes information about the sender and receiver of the payment, as well as details about the transaction, such as the amount, currency, and date.
|
POST /api/middleware/composer/pain.001
RESULT /api/middleware/composer/pain.001
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get PayloadGet the raw pain.001 payload of the ISO 20022 Protocol for an already submitted request
<?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.09" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:pain.001.001.09 pain.001.001.09.ch.03.xsd"> <CstmrCdtTrfInitn> <GrpHdr> <MsgId>948decc4-282c-44f3-aec9-99de7786</MsgId> <CreDtTm>2023-04-29T05:19:05.611Z</CreDtTm> <NbOfTxs>1</NbOfTxs> <CtrlSum>12.34</CtrlSum> <InitgPty> <Nm>Lucas Müller</Nm> <CtctDtls> <Othr> <ChanlTp>NAME</ChanlTp> <Id>AVIS ISO 20022 Middleware</Id> </Othr> <Othr> <ChanlTp>PRVD</ChanlTp> <Id>AVIS BANK</Id> </Othr> <Othr> <ChanlTp>VRSN</ChanlTp> <Id>0.9</Id> </Othr> <Othr> <ChanlTp>SPSV</ChanlTp> <Id>0201</Id> </Othr> </CtctDtls> </InitgPty> </GrpHdr> <PmtInf> <PmtInfId>948decc4-282c-44f3-aec9-99de7786</PmtInfId> <PmtMtd>TRF</PmtMtd> <BtchBookg>true</BtchBookg> <PmtTpInf> <SvcLvl> <Cd>SEPA</Cd> </SvcLvl> </PmtTpInf> <ReqdExctnDt> <Dt>2023-04-29</Dt> </ReqdExctnDt> <Dbtr> <Nm>Lucas Müller</Nm> </Dbtr> <DbtrAcct> <Id> <IBAN>DE89370400440532013000</IBAN> </Id> <Tp> <Prtry>CWD</Prtry> </Tp> </DbtrAcct> <DbtrAgt> <FinInstnId> <BICFI>TUBDDEDD502</BICFI> </FinInstnId> </DbtrAgt> <CdtTrfTxInf> <PmtId> <InstrId>948decc4-282c-44f3-aec9-99de7786</InstrId> <EndToEndId>371e5b25</EndToEndId> </PmtId> <Amt> <InstdAmt Ccy="EUR">12.34</InstdAmt> </Amt> <Cdtr> <Nm>Philippe Alain LAURENT</Nm> <PstlAdr> <Ctry>FR</Ctry> </PstlAdr> </Cdtr> <CdtrAcct> <Id> <IBAN>FR1420041010050500013M02606</IBAN> </Id> </CdtrAcct> <RmtInf> <Ustrd>AGXF987932SD</Ustrd> </RmtInf> </CdtTrfTxInf> </PmtInf> </CstmrCdtTrfInitn> </Document>
|
POST /api/middleware/composer/payload
RESULT /api/middleware/composer/payload
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pacs.002: MT107For the pain.001 sent directly to the intermediary bank, the Middleware polls, stores and parses the pacs.002 response(s). All the responses are compressed into an archive and streamed via the API.
![]() Sample pacs.002 content <?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.002.001.10" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:pain.002.001.10 pain.002.001.10.xsd"> <CstmrPmtStsRpt> <GrpHdr> <MsgId>81510dc-730</MsgId> <CreDtTm>2023-04-29T05:30:32.051Z</CreDtTm> <InitgPty> <Id> <OrgId> <AnyBIC>CRESCHZZ</AnyBIC> </OrgId> </Id> </InitgPty> </GrpHdr> <OrgnlGrpInfAndSts> <OrgnlMsgId>c0e48574-8da2-49f8-a144-0bc98da0</OrgnlMsgId> <OrgnlMsgNmId>pain.001.001.09.ch.02</OrgnlMsgNmId> <GrpSts>ACCP</GrpSts> </OrgnlGrpInfAndSts> </CstmrPmtStsRpt> </Document>
|
POST /api/middleware/composer/pacs.002
RESULT /api/middleware/composer/pacs.002
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
caaa.001.001.12: Acceptor to Acquirer Card Transactions MTID 0100, MTID 0120 & MTID0200This API endpoint will accept Visa and Mastercard MTID 0100, MTID0120 and MTID0200 requests and convert those to Acceptor to Acquirer Card Transactions caaa.001.001.12 payloads. The corresponding MTID 0110, MTID 0130 and MTID0210 can be retrieved from API endpoint {{url}}/api/middleware/composer/caaa.002.001.12.mtid0110_mtid0130_mtid0210The Acceptor to Acquirer Card Transactions are received by the Intermediary Bank (simulator). The intermediary then generates Acquirer to Issuer Card Transactions Payload (cain.001.001.03) and sends this to the Issuer for final authorization and settlement.
This endpoint will accept MTID 0100, MTID 0120, and MTID0200
<?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.001.001.12" xmlns:xs="http:// www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="urn:iso:std:iso:20022:tech:xsd:caaa.001.001.12"> <AcceptorAuthorisationRequest12> <Hdr> <XchgId>7a2dbd45-adfd-40a2-9aa0-b550a29f</XchgId> <CreDtTm>2023-06-19T09:55:59.742Z</CreDtTm> <InitgPty> <Id>AVIS Bank</Id> <AcqrrCtrCode>932</AcqrrCtrCode> <AcqrrInstCode>56444500</AcqrrInstCode> <FwrdInstCode></FwrdInstCode> </InitgPty> </Hdr> <Card> <PlainCardData> <PAN>5644450004100000014</PAN> <CardSeqNb></CardSeqNb> <Track2Dt></Track2Dt> <XpryDt>2704</XpryDt> </PlainCardData> </Card> <Tx> <Initn> <Amt>1000</Amt> <Ccy></Ccy> <RcptTxId>7a2dbd45-adfd-40a2-9aa0-b550a29f</RcptTxId> </Initn> <AddtlTxData> <ProcessingCode>000000</ProcessingCode> <TrxDateTime>082642 0502</TrxDateTime> <STAN>000259</STAN> </AddtlTxData> </Tx> <ProprietaryBankTransactionCode> <PrtryEntryMode>021</PrtryEntryMode> <PrtryCondMode>02</PrtryCondMode> </ProprietaryBankTransactionCode> <NtryDtls> <TxDtls> <Refs> <EndToEndId>7a2dbd45-adfd-40a2-9aa0-b550a29f</EndToEndId> </Refs> </TxDtls> </NtryDtls> <POI> <Id> <PrtryId>00000061</PrtryId> </Id> <Cmpnt> <Id>112200 00002064</Id> </Cmpnt> </POI> <AddtlTxData> <Field47></Field47> <Field55></Field55> </AddtlTxData> </AcceptorAuthorisationRequest12> </xs:schema>
|
POST /api/.../caaa.002.001.12.mtid0110_mtid0130_mtid0210
RESULT /api/middleware/composer/camt.024.001.05.mtid0120
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
caaa.002.001.12: Responses to caaa.001.001.12 | MTI0110, MTI0130 and MTID0210This API endpoint provides ISO8583 responses equivalent to ISO20022 caaa.002.001.12 responses. The responses from this API are conducted using the API endpoint {{url}}/api/middleware/composer/caaa.001.001.12.mtid
|
POST /api/.../caaa.002.001.12.mtid0110_mtid0130_mtid0210
RESULT /api/.../caaa.002.001.12.mtid0110_mtid0130
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iso8583Responses: MTID 0110, MTID 0210, MTID 130This endpoint will send the ISO8583Responses to MTID 0100, MTID 0200, MTID 0120.
![]()
02320110722220010E828000195644450001500000107 000000000000001000061923105600000406305310856 444500708381089031LAYNLV000001000210650120000 000000005508ECOCZWHX61112200 0000206223385644 451700200003105686312547016270254641600000000 00087218840
|
POST /api/middleware/composer/iso8583Responses
RESULT /api/middleware/composer/iso8583Responses
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|