AVIS Bank API Reference

 

 

Sandbox Information

API endpoint:
  • https://connect.avisbank.com:8080
API Secret:
  • Given by administrator
Input Variations:
  • Mandatory Fields are marked with the letter ‘m’
  • Conditionally Mandatory Fields are marked with the letter ‘c’

 

 

 

Create User

  • Endpoint

    • POST /api/middleware/users/create

  • Data Parameters

Name Type Notes Mandatory
api_secret string   m
email_address string   m
password string   m
first_name string   m
last_name string   m
phone_number string   m
country_code string(2) ISO 3166-1 alpha-2 m
role int 0 = Admin, 1 = Customer m
  • Notes

    • N/A

  • Successful response: HTTP 200

    • {
      "xid": "8157",
      "email_address": "b99af433-baeb-4ceb-ba77-8d9df48b07a2@test.com",
      "first_name": "Joe",
      "last_name": "Doe",
      "phone_number": "+1234567896",
      "country_code": "US",
      "role": "customer",
      "status": "active",
      "date_created": "2023-04-29T02:26:42.000Z",
      "date_update": "2023-04-29T02:26:42.000Z"
      }

  • Error Responses

HTTP Code Response
400 {
"message": "Invalid API Secret."
}
400 {
"message": "Invalid Email."
}
400 {
"message": "Invalid Password."
}
400 {
"message": "role valid values '0' | '1'. 0 = Admin. 1 = User."
}
500 {
"message": "Error while processing."
}
400 {
"message": "Email already registered."
}
500 {
"message": "Error occurred while creating user."
}

 

 

POST /api/middleware/users/create
api_secret:
email_address:
password:
first_name:
last_name:
phone_number:
country_code:
role:

RESULT /api/middleware/users/create
Response Here

 

 

Initiate Session

The 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.

  • Endpoint

    • POST /api/middleware/session/start

  • Data Parameters

Name Type Notes Mandatory
email_address string   m
password string   m
  • Notes

    • N/A

  • Successful response: HTTP 200

    • {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ4aWQiOjgxNjMsImVtYWlsX2FkZHJlc3MiOiI3NWM4Y zc0Yi1kYjE0LTRkMDYtODQ0Yy1hOTI4NzgwYzQ4ZmJAdGVzdC5jb20iLCJpYXQiOjE2ODI3NDE4O DUsImV4cCI6MTY4Mjc0NTQ4NX0.eF-e_VwtqIF9yiZzkdrifhP6yWUV8T27YMdWgB9wA58"
      }

  • Error Responses

HTTP Code Response
400 {
"message": "Invalid API Secret."
}
400 {
"message": "Email address required."
}
404 {
"message": "Not found email_address 75c8c74b-db14-4d06-844ca928780c48fb@test.com."
}
401 {
"message": “Incorrect credentials.”
}

 

 

 

 

POST /api/middleware/session/start
email_address:
password:

RESULT /api/middleware/session/start
Response Here

 

 

Initiate Nexor Session

Similar 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.

  • Endpoint

    • POST /api/middleware/session/nexor_start

  • Data Parameters

Name Type Notes Mandatory
api_key string *api_key* m
username string test.account@avis.technology m
  • Notes

    • All sessions are valid for 60 minutes

  • Successful response: HTTP 200

    • {
      "firstName": "AvisTest",
      "lastName": "TestAccount",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ4aWQiOjgxNjMsImVtYWlsX2FkZHJlc3MiOiI3NWM4Y zc0Yi1kYjE0LTRkMDYtODQ0Yy1hOTI4NzgwYzQ4ZmJAdGVzdC5jb20iLCJpYXQiOjE2ODI3NDE4O DUsImV4cCI6MTY4Mjc0NTQ4NX0.eF-e_VwtqIF9yiZzkdrifhP6yWUV8T27YMdWgB9wA58"
      }

  • Error Responses

HTTP Code Response
400 {
"message": "API Key Required"
}
400 {
"message": "Username required."
}
404 {
"message": "Not found username 75c8c74b-db14-4d06-844ca928780c48fb@test.com."
}
401 {
"message": “Incorrect api_key”
}

 

 

 

 

POST /api/middleware/session/nexor_start
api_key:
username:

RESULT /api/middleware/session/nexor_start
Response Here

 

 

Terminate Session

Terminate JWT Authentication Session
  • Endpoint

    • POST /api/middleware/session/stop

  • Data Parameters

    • N/A
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200

    • {
      "message": "Success."
      }

  • Error Responses

HTTP Code Response
401

 

 

 

POST /api/middleware/session/stop
No parameters

RESULT /api/middleware/session/stop
Response Here

 

 

 

pain.001: MT101 & MT103

The 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.
  • Customer Credit Transfer Initiation (pain.001): This message replaces the MT101, which is used for initiating credit transfers between financial institutions. The pain.001 message provides detailed information about the initiating party, the beneficiary, the payment amount and currency, and any additional information relevant to the payment transaction.
  • Single Customer Credit Transfer (pain.001): This message replaces the MT103, which is used for credit transfers between financial institutions. The pain.001 message is also used for credit transfers between non-financial institutions and financial institutions. The message provides information on the initiating party, the beneficiary, the payment amount and currency, and any additional information relevant to the payment transaction.
  • Endpoint

    • POST /api/middleware/composer/pain.001

  • Data Parameters

Name Type Notes Mandatory
transfer_method string OUTBOUND | INBOUND | EXTERNAL
transfer_currency string(3) ISO 4217 code m
transfer_amount int Hundreths. Example 12.34 should be input as 1234 m
transfer_reference string m
sender_bank string m
sender_branch string m
sender_country string(2) ISO 3166-2 code m
sender_number int
sender_name string m
sender_SWIFT string m
sender_SORT int
sender_IBAN string m
receiver_bank string m
receiver_branch string m
receiver_country string(2) ISO 3166-2 code m
receiver_number int
receiver_name string m
receiver_SWIFT string m
receiver_SORT int
receiver_IBAN string m
invoice_number string m
invoice_description string c
instructions string m
workflow string GENERATE | GENERATE_SEND m
  • Notes

    • Requires JWT Bearer Token

    • Specify GENERATE to only create the payload. The created payload can be downloaded from the API endpoint '/api/middleware/composer/payload'

    • Specify GENERATE_SEND to send the payload to the intermediary bank from the Middleware. The responses from the intermediary bank can be retrieved from the API endpoint 'api/middleware/composer/pacs.002'

  • Successful response: HTTP 200

    • {
      "message":
         {
         "message_id": "7e2925ff-c217-4683-a48d-95dbb761",
         "status": "ACCP",
         "transfer_reference": "371e5b25"
         }
      }

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "transfer_currency required"
}
400 {
"message": "transfer_currency must be valid ISO 4217 code"
}
400 {
"message": "transfer_amount required"
}
400 {
"message": "transfer_amount must be numerical between 1 and 12 digits represented as hundredths. Example 12.34 should be input as 1234"
}
400 {
"message": "transfer_reference required"
}
400 {
"message": "transfer_reference must between 6 and 32 characters long"
}
400 {
"message": "sender_bank required"
}
400 {
"message": "sender_bank must between 3 and 64 characters long"
}
400 {
"message": "sender_branch required"
}
400 {
"message": "sender_branch must between 3 and 128 characters long"
}
400 {
"message": "sender_country required"
}
400 {
"message": "sender_country must ISO 3166 code"
}
400 {
"message": "sender_number must be between 6 and 24 characters long"
}
400 {
"message": "sender_name required"
}
400 {
"message": "sender_name must be between 3 and 64 characters long"
}
400 {
"message": "sender_SWIFT required"
}
400 {
"message": "sender_SWIFT must be between 6 and 12 characters long"
}
400 {
"message": "sender_SORT must be between 6 and 18 characters long"
}
400 {
"message": "sender_IBAN required"
}
400 {
"message": "sender_IBAN must be between 16 and 32 characters long"
}
400 {
"message": "sender_IBAN is not valid"
}
400 {
"message": "receiver_bank required"
}
400 {
"message": "receiver_bank must between 3 and 64 characters long"
}
400 {
"message": "receiver_branch required"
}
400 {
"message": "receiver_branch must between 3 and 128 characters long"
}
400 {
"message": "receiver_country required"
}
400 {
"message": "receiver_country must ISO 3166 code"
}
400 {
"message": "receiver_number must be between 6 and 24 characters long"
}
400 {
"message": "receiver_name required"
}
400 {
"message": "receiver_name must be between 3 and 64 characters long"
}
400 {
"message": "receiver_SWIFT required"
}
400 {
"message": "receiver_SWIFT must be between 6 and 12 characters long"
}
400 {
"message": "receiver_SORT must be between 6 and 18 characters long"
}
400 {
"message": "receiver_IBAN required"
}
400 {
"message": "receiver_IBAN must be between 16 and 32 characters long"
}
400 {
"message": "receiver_IBAN is not valid"
}
400 {
"message": "invoice_number must be between 8 and 16 characters long"
}
400 {
"message": "invoice_description is required when invoice_number is specified"
}
400 {
"message": "invoice_description must be between 3 and 64 characters long"
}
400 {
"message": "instructions required"
}
400 {
"message": "instructions must be between 3 and 256 characters long"
}
400 {
"message": "workflow required"
}
400 {
"message": "workflow valid values 'GENERATE' | 'GENERATE_SEND'"
}
400 {
"message": "Only customer role can use function"
}
500 {
"message": "Error occurred while processing”
}
500 {
"message": "File not found”
}

 

 

 

 

POST /api/middleware/composer/pain.001
transfer_method:
transfer_currency:
transfer_amount:
transfer_reference:
sender_bank:
sender_branch:
sender_country:
sender_number:
sender_name:
sender_SWIFT:
sender_SORT:
sender_IBAN:
receiver_bank:
receiver_branch:
receiver_country:
receiver_number:
receiver_name:
receiver_SWIFT:
receiver_SORT:
receiver_IBAN:
invoice_number:
invoice_description:
instructions:
workflow:

RESULT /api/middleware/composer/pain.001
Response Here

 

 

 

Get Payload

Get the raw pain.001 payload of the ISO 20022 Protocol for an already submitted request
  • Endpoint

    • POST /api/middleware/composer/payload

  • Data Parameters

Name Type Notes Mandatory
message_id string   m
  • Notes

    • Requires JWT Bearer Token

    • Returns the raw XML in the HTTP body of the response

  • Successful response: HTTP 200

<?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>

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "message_id required."
}
404 {
"message": ""message": "Payload not found. message_id = 948decc4-282c-44f3-aec9-99de7786"
}

 

 

 

 

POST /api/middleware/composer/payload
message_id:

RESULT /api/middleware/composer/payload
Response Here

 

 

 

pacs.002: MT107

For 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.
  • Endpoint

    • POST /api/middleware/composer/pacs.002

  • Data Parameters

Name Type Notes Mandatory
message_id string   m
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200

    • Zip archive with pacs.002 response(s) is streamed to 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>

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "message_id required."
}
404 {
"message": "Payload not found. message_id = 948decc4-282c-44f3-aec9-99de7786"
}

 

 

 

 

POST /api/middleware/composer/pacs.002
message_id:

RESULT /api/middleware/composer/pacs.002
Response Here

 

 

 

auth.010: MTID 0100

This API endpoint will accept Visa and Mastercard MTID 0100 and convert those to auth.010.001.05 payloads.
  • Endpoint

    • POST /api/middleware/composer/auth.010.005.01.mtid0100

  • Data Parameters

Name Type Notes Mandatory
mtid string {MTID0100 Payload} m
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200


<?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>

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "mtid is required."
}

 

 

 

 

POST /api/middleware/composer/auth.010.005.01.mtid0100
mtid:

RESULT /api/middleware/composer/auth.010.005.01.mtid0100
Response Here

 

 

 

pacs.004: MTID 0200

This API endpoint will accept Visa and Mastercard MTID 0200 refund requests and convert those to pacs.004.005.01 payloads.
  • Endpoint

    • POST /api/middleware/composer/pacs.004.005.01.mtid0200

  • Data Parameters

Name Type Notes Mandatory
mtid string {MTID0200 Payload} m
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200


<?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>

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "mtid is required."
}

 

 

 

 

POST /api/middleware/composer/pacs.004.005.01.mtid0200
mtid:

RESULT /api/middleware/composer/pacs.004.005.01.mtid0200
Response Here

 

 

 

camt.024: Forced Payments MTID 0120

This 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
  • Endpoint

    • POST /api/middleware/composer/camt.024.001.05.mtid0120

  • Data Parameters

Name Type Notes Mandatory
mtid string {MTID0120 Payload} m
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200


<?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>

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "mtid is required."
}

 

 

 

 

POST /api/middleware/composer/camt.024.001.05.mtid0120
mtid:

RESULT /api/middleware/composer/camt.024.001.05.mtid0120
Response Here

 

 

 

iso8583Responses: MTID 0110, MTID 0210, MTID 130

This endpoint will send the ISO8583Responses to MTID 0100, MTID 0200, MTID 0120.
  • Endpoint

    • POST /api/middleware/composer/iso8583Responses

  • Data Parameters

Name Type Notes Mandatory
message_id string messsage_id is equivalent to <XchgId> in the response payload as highlighted below. m
  • Notes

    • Requires JWT Bearer Token

  • Successful response: HTTP 200

[ | 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 | ]

  • Error Responses

HTTP Code Response
401 Unauthorized
400 {
"message": "message_id is required."
}

 

 

 

 

POST /api/middleware/composer/iso8583Responses
message_id:

RESULT /api/middleware/composer/iso8583Responses
Response Here