Payment+ » Documentations » Create Payment File

Create Payment File

This api allows you to create a ISO20022 payment file according to your Bank Account specs.

Generic specifications will work for 80% of banks. Please use these generic specifications for any generic bank payment in Europe and in the US and other countries unless specified below (SEPA, RTGS, TT, ACH, etc..).

Some exceptions may be applied for some countries/banks, check the list of exceptions page or consult you bank for more info.

All Banks

All banks specifications

  • All Banks
/payments/create
Create an ISO2002 payment file
Param Type Max Size Required
InitiatingPartyName Text 140 NO The name of the party who initiated the credit transfer
InitiatingPartyCountry Code 2 NO The country of the party who initiated the credit transfer
InitiatingPartyAddressLine Text 140 NO The address of the party who initiated the credit transfer
InitiatingPartyIdentification Text 35 YES The identification of the party who initiated the credit transfer
DebtorName Text 140 NO The debtor name
DebtorCountry Code 2 NO The debtor country (2 characters ISO standard)
DebtorAddressLine Text 140 NO The debtor address line
DebtorAgentName Text 140 NO The debtor agent name ( could be bank name)
DebtorAgentBIC Text 11 YES The bank BIC
DebtorAgentCountry Code 2 NO The bank country
DebtorAgentAddressLine Text 140 NO The bank address
DebtorAccountLocalAccount Text 34 (YES or Debtor Local Account
DebtorAccountIBAN Text 34 YES) Debtor IBAN Account
DebtorAccountCurrency Code 3 YES The debtor currency
EmployerID Text 35 NO Ordering Customer ID
MosalID Text 35 NO Ministry of Labour
MessageIdentification Text 35 YES Unique Id for the payment
RequestedExecutionDate Date 10 YES Date format is YYYY-MM-DD
CategoryPurpose Text 11 YES SALDOM for Domestic Salaries SALINT for International Salaries SUPDOM for Domestic Supplier Payments SUPINT for International Supplier Payments TREASURYDOM for Domestic Treasury transfer TREASURYINT for International Treasury Transfer
ChargeBearer Code 4 YES CRED All transaction charges are to be borne by the creditor. DEBT All transaction charges are to be borne by the debtor. SHAR Both parties bear their own charges. SLEV Both parties bear their own charges.
PaymentMethod Code 3 YES TRF: Transfer Advice CHK: Check TRA: Credit Transfer
ServiceLevel Text 35 YES BKTR: Book Transaction NUGP: Non-urgent Priority Payment NURG: Non-urgent Payment PRPT: EBAPriorityService SDVA: SameDayValue SEPA: SingleEuroPaymentsArea URGP: Urgent Payment URNS: Urgent Payment Net Settlement
LocalInstrument Text 35 NO This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
CreditorIdentification Text 35 NO Creditor Identifier
CreditorName Text 140 YES Creditor Name
CreditorEmployeeNumber Text 35 NO Beneficiary Number
CreditorAddressLine Text 140 NO Creditor Address
CreditorCountry Code 2 NO Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
CreditorAgentName Text 140 NO The beneficiary Bank Name
CreditorAgentCountry Code 2 NO Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
CreditorAgentAddressLine Text 140 NO Bank Address
CreditorAgentBIC Text 11 (YES or BIC for IBAN, SORTCode, Fedwire, Other,CSMI
CreditorAgentCSMICode Text 35 YES or
CreditorAgentOtherCode Text 35 YES) The beneficiary Bank Code. Incorrect bank code will result in rejection at the payment processing side.
CreditorAccountIBAN Text 34 (YES or
CreditorAccountLocalAccount Text 34 YES) The beneficiary account number (IBAN or Other)
CreditorAccountCurrency Code 3 NO Must Conform to ISO 4217 Currency http://en.wikipedia.org/wiki/ISO_4217
IntermediaryAgentName Text 140 NO In case intermediary bank is used, all intermediary bank fields must be filled
IntermediaryAgentCountry Code 2 NO Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
IntermediaryAgentBIC Text 11 NO In case intermediary bank is used, the BIC must be provided
IntermediaryAgentAddressLine Text 140 NO In case intermediary bank is used, the bank address must be provided
TransactionAmount Decimal 18 YES Positive, decimal.
TransactionCurrency Code 3 YES Must conform to ISO 4217 Currency
InstructionIdentification Text 35 YES Transaction Unique Reference
Purpose Text 35 NO Payment Format Specific.
InstructionForCreditorAgent Text 140 NO information complementing the coded instruction or instruction to the creditor`s agent that is bilaterally agreed or specific to a user community. To use code words not supported by ISOXML but supported by the branch.
InstructionForDebtorAgent Text 140 NO information related to the processing of the payment instruction that may need to be acted upon by the Debtoragent, depending on agreement between Debtorand the Debtoragent.
RegulatoryReportingCode Text 10 NO
RegulatoryReportingInfo Text 35 NO
RemittanceInformation Text 140 NO The invoice number or any kind of description to be sent with the payment. It is very important to enter this information from the ERP to facilitate in reconciliation afterwards
BasicSalary Decimal 18 NO Beneficiary Basic Salary
HousingAllowance Decimal 18 NO Housing Allowance
OtherAllowance Decimal 18 NO Other Allowance
Deductions Decimal 18 NO Deduction
InitiatingPartyName Text The name of the party who initiated the credit transfer
InitiatingPartyCountry Code The country of the party who initiated the credit transfer
InitiatingPartyAddressLine Text The address of the party who initiated the credit transfer
InitiatingPartyIdentification * Text The identification of the party who initiated the credit transfer
DebtorName Text The debtor name
DebtorCountry Code The debtor country (2 characters ISO standard)
DebtorAddressLine Text The debtor address line
DebtorAgentName Text The debtor agent name ( could be bank name)
DebtorAgentBIC * Text The bank BIC
DebtorAgentCountry Code The bank country
DebtorAgentAddressLine Text The bank address
DebtorAccountLocalAccount * Text Debtor Local Account
DebtorAccountIBAN * Text Debtor IBAN Account
DebtorAccountCurrency * Code The debtor currency
EmployerID Text Ordering Customer ID
MosalID Text Ministry of Labour
MessageIdentification * Text Unique Id for the payment
RequestedExecutionDate * Date Date format is YYYY-MM-DD
CategoryPurpose * Text SALDOM for Domestic Salaries SALINT for International Salaries SUPDOM for Domestic Supplier Payments SUPINT for International Supplier Payments TREASURYDOM for Domestic Treasury transfer TREASURYINT for International Treasury Transfer
ChargeBearer * Code CRED All transaction charges are to be borne by the creditor. DEBT All transaction charges are to be borne by the debtor. SHAR Both parties bear their own charges. SLEV Both parties bear their own charges.
PaymentMethod * Code TRF: Transfer Advice CHK: Check TRA: Credit Transfer
ServiceLevel * Text BKTR: Book Transaction NUGP: Non-urgent Priority Payment NURG: Non-urgent Payment PRPT: EBAPriorityService SDVA: SameDayValue SEPA: SingleEuroPaymentsArea URGP: Urgent Payment URNS: Urgent Payment Net Settlement
LocalInstrument Text This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
CreditorIdentification Text Creditor Identifier
CreditorName * Text Creditor Name
CreditorEmployeeNumber Text Beneficiary Number
CreditorAddressLine Text Creditor Address
CreditorCountry Code Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
CreditorAgentName Text The beneficiary Bank Name
CreditorAgentCountry Code Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
CreditorAgentAddressLine Text Bank Address
CreditorAgentBIC * Text BIC for IBAN, SORTCode, Fedwire, Other,CSMI
CreditorAgentCSMICode * Text
CreditorAgentOtherCode * Text The beneficiary Bank Code. Incorrect bank code will result in rejection at the payment processing side.
CreditorAccountIBAN * Text
CreditorAccountLocalAccount * Text The beneficiary account number (IBAN or Other)
CreditorAccountCurrency Code Must Conform to ISO 4217 Currency http://en.wikipedia.org/wiki/ISO_4217
IntermediaryAgentName Text In case intermediary bank is used, all intermediary bank fields must be filled
IntermediaryAgentCountry Code Must Conform to ISO 3166 Alpha 2 http://en.wikipedia.org/wiki/ISO_3166-1
IntermediaryAgentBIC Text In case intermediary bank is used, the BIC must be provided
IntermediaryAgentAddressLine Text In case intermediary bank is used, the bank address must be provided
TransactionAmount * Decimal Positive, decimal.
TransactionCurrency * Code Must conform to ISO 4217 Currency
InstructionIdentification * Text Transaction Unique Reference
Purpose Text Payment Format Specific.
InstructionForCreditorAgent Text information complementing the coded instruction or instruction to the creditor`s agent that is bilaterally agreed or specific to a user community. To use code words not supported by ISOXML but supported by the branch.
InstructionForDebtorAgent Text information related to the processing of the payment instruction that may need to be acted upon by the Debtoragent, depending on agreement between Debtorand the Debtoragent.
RegulatoryReportingCode Text
RegulatoryReportingInfo Text
RemittanceInformation Text The invoice number or any kind of description to be sent with the payment. It is very important to enter this information from the ERP to facilitate in reconciliation afterwards
BasicSalary Decimal Beneficiary Basic Salary
HousingAllowance Decimal Housing Allowance
OtherAllowance Decimal Other Allowance
Deductions Decimal Deduction
POST /payments/api/create HTTP/1.1
Host: api.treasuryxpress.com
Content-Type: application/json
Authorization: Bearer CfDJ8OpcEOrPwjdIkq75JPHAl...            

{
    "InitiatingPartyIdentification": "XXXXXX",
    "MessageIdentification" : "MessageID",
    "PaymentMethod" : "TRF",
    "RequestedExecutionDate" : "2017-03-21",
    "ServiceLevel" : "URGP",
    "DebtorAgentBIC" : "XXXXXXXX",
    "DebtorAccountIBAN" : "LB96289626797525466611292851",
    "DebtorAccountCurrency" : "USD",
    "ChargeBearer" : "CRED",
    "CategoryPurpose" : "SUPINT",
    "Transactions" : [{
        "CreditorName" : "Cdtr Name",
        "CreditorAgentBIC" :"XXXXXXXX",
        "CreditorAccountLocalAccount" : "97846512784651",
        "TransactionAmount" : 1.00,
        "TransactionCurrency" : "USD",
        "InstructionIdentification": "TRF01"
    }]
}
curl -X POST 
-H "Content-Type: application/json" 
-H "Authorization: Bearer CfDJ8OpcEOrPwjdIkq75JPHAl..."
-d '{
        "InitiatingPartyIdentification": "XXXXXX",
        "MessageIdentification" : "MessageID",
        "PaymentMethod" : "TRF",
        "RequestedExecutionDate" : "2017-03-21",
        "ServiceLevel" : "URGP",
        "DebtorAgentBIC" : "XXXXXXXX",
        "DebtorAccountIBAN" : "LB96289626797525466611292851",
        "DebtorAccountCurrency" : "USD",
        "ChargeBearer" : "CRED",
        "CategoryPurpose" : "SUPINT",
        "Transactions" : [{
            "CreditorName" : "Cdtr Name",
            "CreditorAgentBIC" :"XXXXXXXX",
            "CreditorAccountLocalAccount" : "97846512784651",
            "TransactionAmount" : 1.00,
            "TransactionCurrency" : "USD",
            "InstructionIdentification": "TRF01"
        }]
    }' 
"https://api.treasuryxpress.com/payments/api/create"            
    <ns0:CstmrCdtTrfInitn>
        <ns0:GrpHdr>
            <ns0:MsgId>MessageID</ns0:MsgId>
            <ns0:CreDtTm>2017-03-21T15:02:37.6419468+00:00</ns0:CreDtTm>
            <ns0:NbOfTxs>1</ns0:NbOfTxs>
            <ns0:CtrlSum>1.00</ns0:CtrlSum>
            <ns0:InitgPty>
                <ns0:Id>
                    <ns0:OrgId>
                        <ns0:Othr>
                            <ns0:Id>XXXXXX</ns0:Id>
                        </ns0:Othr>
                    </ns0:OrgId>
                </ns0:Id>
            </ns0:InitgPty>
        </ns0:GrpHdr>
        <ns0:PmtInf>
            <ns0:PmtInfId>MessageID</ns0:PmtInfId>
            <ns0:PmtMtd>TRF</ns0:PmtMtd>
            <ns0:PmtTpInf>
                <ns0:SvcLvl>
                    <ns0:Cd>URGP</ns0:Cd>
                </ns0:SvcLvl>
                <ns0:CtgyPurp>
                    <ns0:Prtry>SUPINT</ns0:Prtry>
                </ns0:CtgyPurp>
            </ns0:PmtTpInf>
            <ns0:ReqdExctnDt>2017-03-21</ns0:ReqdExctnDt>
            <ns0:Dbtr />
            <ns0:DbtrAcct>
                <ns0:Id>
                    <ns0:IBAN>LB96289626797525466611292851</ns0:IBAN>
                </ns0:Id>
            </ns0:DbtrAcct>
            <ns0:DbtrAgt>
                <ns0:FinInstnId>
                    <ns0:BIC>XXXXXXXX</ns0:BIC>
                    <ns0:PstlAdr>
                        <ns0:Ctry>XX</ns0:Ctry>
                    </ns0:PstlAdr>
                </ns0:FinInstnId>
            </ns0:DbtrAgt>
            <ns0:CdtTrfTxInf>
                <ns0:PmtId>
                    <ns0:InstrId>TRF01</ns0:InstrId>
                    <ns0:EndToEndId>TRF01</ns0:EndToEndId>
                </ns0:PmtId>
                <ns0:Amt>
                    <ns0:InstdAmt Ccy="USD">1.00</ns0:InstdAmt>
                </ns0:Amt>
                <ns0:ChrgBr>CRED</ns0:ChrgBr>
                <ns0:CdtrAgt>
                    <ns0:FinInstnId>
                        <ns0:BIC>XXXXXXXX</ns0:BIC>
                        <ns0:PstlAdr>
                            <ns0:Ctry>XX</ns0:Ctry>
                        </ns0:PstlAdr>
                    </ns0:FinInstnId>
                </ns0:CdtrAgt>
                <ns0:Cdtr>
                    <ns0:Nm>Cdtr Name</ns0:Nm>
                </ns0:Cdtr>
                <ns0:CdtrAcct>
                    <ns0:Id>
                        <ns0:Othr>
                            <ns0:Id>97846512784651</ns0:Id>
                        </ns0:Othr>
                    </ns0:Id>
                </ns0:CdtrAcct>
            </ns0:CdtTrfTxInf>
        </ns0:PmtInf>
    </ns0:CstmrCdtTrfInitn>
</ns0:Document>           

Would you like to have payment specifications integrated for other banks and countries?

CONTACT US