AVIS Bank API Reference
Sandbox InformationAPI endpoint:
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create User
|
POST /api/middleware/users/create
RESULT /api/middleware/users/create
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Initiate SessionThe Middleware uses Bearer token JWT Authentication. JSON Web Token (JWT) authentication is a method of securing web applications by creating and verifying JSON-based access tokens. JWT allows for stateless authentication, meaning the server does not need to maintain session information for each user. This can lead to better scalability and performance, especially for large-scale applications.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/start
RESULT /api/middleware/session/start
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 60 minute 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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terminate SessionTerminate JWT Authentication Session
|
POST /api/middleware/session/stop
RESULT /api/middleware/session/stop
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
auth.010: MTID 0100This API endpoint will accept Visa and Mastercard MTID 0100 and convert those to auth.010.001.05 payloads.
<?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.010.001.05" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <AccptrAuthstnReq> <Hdr> <MsgFctn>AUTQ</MsgFctn> <PrtcolVrsn>3.0</PrtcolVrsn> <XchgId>d20e2688-e78a-486c-9b45-c8f1012b</XchgId> <CreDtTm>2023-05-06T08:05:22.792Z</CreDtTm> <InitgPty> <Id>AVIS Bank</Id> </InitgPty> <MsgRcpt> <Id> <OrgId> <Othr> <Id>231257716000051</Id> </Othr> </OrgId> </Id> </MsgRcpt> </Hdr> <AuthstnReq> <Envt> <Mrchnt> <CmonNm>3032396805 JOSEFGASSE 1</CmonNm> </Mrchnt> <POI> <Id> <PrtryId>Terminal001</PrtryId> </Id> <Cmpnt> <Id>CardReader</Id> <VrsnNb>1.0</VrsnNb> </Cmpnt> </POI> <Card> <PlainCardData> <PAN>4929600002000005</PAN> <CardSeqNb>0 00001</CardSeqNb> <XpryDt>2408</XpryDt> </PlainCardData> </Card> </Envt> <Cntxt> <PmtCntxt> <CardPres>CardPresent</CardPres> <Attndnc>Unattended</Attndnc> <TxTp>ATM withdrawal</TxTp> </PmtCntxt> </Cntxt> <NtryDtls> <TxDtls> <Refs> <EndToEndId>31325000 000740</EndToEndId> </Refs> </TxDtls> </NtryDtls> <ProprietaryBankTransactionCode> <Cd>MCC</Cd> <Issr>ISO</Issr> <Prtry>6012</Prtry> </ProprietaryBankTransactionCode> <CdtrAgt> <FinInstnId> <Othr> <Id>3036412772</Id> </Othr> </FinInstnId> </CdtrAgt> <Tx> <Initn> <Amt>2650</Amt> <Ccy>_transaction_currency</Ccy> <RcptTxId>_rrn_de_037</RcptTxId> </Initn> <AddtlTxData>AdviceReasonCode=31325000 000740</AddtlTxData> </Tx> </AuthstnReq> </AccptrAuthstnReq> </Document>
|
POST /api/middleware/composer/auth.010.005.01.mtid0100
RESULT /api/middleware/composer/auth.010.005.01.mtid0100
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pacs.004: MTID 0200This API endpoint will accept Visa and Mastercard MTID 0200 refund requests and convert those to pacs.004.005.01 payloads.
<?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.004.001.05" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <AccptrAuthstnReq> <Hdr> <MsgFctn>AUTQ</MsgFctn> <PrtcolVrsn>3.0</PrtcolVrsn> <XchgId>d20e2688-e78a-486c-9b45-c8f1012b</XchgId> <CreDtTm>2023-05-06T08:05:22.792Z</CreDtTm> <InitgPty> <Id>AVIS Bank</Id> </InitgPty> <MsgRcpt> <Id> <OrgId> <Othr> <Id>231257716000051</Id> </Othr> </OrgId> </Id> </MsgRcpt> </Hdr> <AuthstnReq> <Envt> <Mrchnt> <CmonNm>3032396805 JOSEFGASSE 1</CmonNm> </Mrchnt> <POI> <Id> <PrtryId>Terminal001</PrtryId> </Id> <Cmpnt> <Id>CardReader</Id> <VrsnNb>1.0</VrsnNb> </Cmpnt> </POI> <Card> <PlainCardData> <PAN>4929600002000005</PAN> <CardSeqNb>0 00001</CardSeqNb> <XpryDt>2408</XpryDt> </PlainCardData> </Card> </Envt> <Cntxt> <PmtCntxt> <CardPres>CardPresent</CardPres> <Attndnc>Unattended</Attndnc> <TxTp>ATM withdrawal</TxTp> </PmtCntxt> </Cntxt> <NtryDtls> <TxDtls> <Refs> <EndToEndId>31325000 000740</EndToEndId> </Refs> </TxDtls> </NtryDtls> <ProprietaryBankTransactionCode> <Cd>MCC</Cd> <Issr>ISO</Issr> <Prtry>6012</Prtry> </ProprietaryBankTransactionCode> <CdtrAgt> <FinInstnId> <Othr> <Id>3036412772</Id> </Othr> </FinInstnId> </CdtrAgt> <Tx> <Initn> <Amt>2650</Amt> <Ccy>_transaction_currency</Ccy> <RcptTxId>_rrn_de_037</RcptTxId> </Initn> <AddtlTxData>AdviceReasonCode=31325000 000740</AddtlTxData> </Tx> </AuthstnReq> </AccptrAuthstnReq> </Document>
|
POST /api/middleware/composer/pacs.004.005.01.mtid0200
RESULT /api/middleware/composer/pacs.004.005.01.mtid0200
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
camt.024: Forced Payments MTID 0120This API endpoint will accept Visa and Mastercard MTID 0120 requests and convert those to camt.024.001.05 payloads. The corresponding MTID 0130 can be retrieved from API endpoint {{url}}/api/middleware/composer/iso8583Responses
<?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.024.001.05" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance"> <AccptrAuthstnReq> <Hdr> <MsgFctn>AUTQ</MsgFctn> <PrtcolVrsn>3.0</PrtcolVrsn> <XchgId>00d7a3f5-f110-4373-b43b-eec5bf6d</XchgId> <CreDtTm>2023-05-07T21:04:24.279Z</CreDtTm> <InitgPty> <Id>AVIS Bank</Id> </InitgPty> </Hdr> <AuthstnReq> <Envt> <Mrchnt> <CmonNm>AVIS</CmonNm> </Mrchnt> <POI> <Id> <PrtryId>Terminal001</PrtryId> </Id> <Cmpnt> <Id>CardReader</Id> <VrsnNb>1.0</VrsnNb> </Cmpnt> </POI> <Card> <PlainCardData> <PAN>5644450004100000014</PAN> <CardSeqNb>000259</CardSeqNb> <XpryDt>2704</XpryDt> </PlainCardData> </Card> </Envt> <Cntxt> <PmtCntxt> <CardPres>CardPresent</CardPres> <Attndnc>Unattended</Attndnc> <TxTp>ATM withdrawal</TxTp> </PmtCntxt> </Cntxt> <NtryDtls> <TxDtls> <Refs> <EndToEndId>0000000000000000000000060</EndToEndId> </Refs> </TxDtls> </NtryDtls> <ProprietaryBankTransactionCode> <Cd>MCC</Cd> <Issr>ISO</Issr> <Prtry>_mcc_de_018</Prtry> </ProprietaryBankTransactionCode> <CdtrAgt> <FinInstnId> <Othr> <Id>56444500</Id> </Othr> </FinInstnId> </CdtrAgt> <Tx> <Initn> <Amt>000000100000</Amt> <Ccy>0978</Ccy> <RcptTxId>0x00000000000000000000000000000</RcptTxId> </Initn> <AddtlTxData>AdviceReasonCode=_advice_reason_code_de_060</AddtlTxData> </Tx> </AuthstnReq> </AccptrAuthstnReq> </Document>
|
POST /api/middleware/composer/camt.024.001.05.mtid0120
RESULT /api/middleware/composer/camt.024.001.05.mtid0120
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iso8583Responses: MTID 0110, MTID 0210, MTID 130This endpoint will send the ISO8583Responses to MTID 0100, MTID 0200, MTID 0120.
![]()
[ | BM: 002 Value: 4929600002000005 | BM: 003 Value: 000000 | BM: 004 Value: 000000265000 | BM: 007 Value: 0502104008 | BM: 011 Value: 0 00001 | BM: 019 Value: 0531 | BM: 025 Value: 59 | BM: 032 Value: 3036412772 | BM: 038 Value: 3pwl9S | BM: 039 Value: 00 | BM: 062.00 Value: 8o8ri000018000000000 | BM: 062.01 Value: N | BM: 062.02 Value: WtgJllUM59ovapNL | BM: 062.24 Value: yGFYyk | BM: 062.25 Value: Q | BM: 063.0 Value: 000000 | BM: 063.1 Value: 0000 | ]
|
POST /api/middleware/composer/iso8583Responses
RESULT /api/middleware/composer/iso8583Responses
Response Here
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|