Individual document in the foreign currency
This method allows creating one or more individual documents in foreign currency.
Params
Chargesoptionalstring
Charges (optional; string) – A transfer method. Can take one of the following values:
- SHA - The Payer (sender of the payment) will pay only fees charged by the sending bank.
- OUR - The Payer (sender of the payment) will pay all fees charged by the sending bank.
ComissionAccountNumberoptionalstring
A fees’ account number.
BeneficiaryBankNameoptionalstring
A receiver Bank name. It is mandatory to fill in either BeneficiaryBankCode or BeneficiaryBankName.
IntermediaryBankCodeoptionalstring
A SWIFT code of an Intermediary Bank.
IntermediaryBankNameoptionalstring
A name of an Intermediary Bank.
PaymentDetailoptionalstring
A reason, purpose of the transfer / 4x34 (136) symbols max.
ValueDaterequireddate
A date of document entry in the bank system.
BeneficiaryRegistrationCountryCodeoptionalstring
Recipient’s registration country.
BeneficiaryActualCountryCodeoptionalstring
Recipient’s actual country.
RecipientAddressoptionalstring
Recipient’s address.
RecipientCityoptionalstring
Recipient’s city.
RegReportingValueoptionalstring
An additional field that is used when transferring to the UAE.
UniqueIdrequiredglobally unique identifier
An unique ID of a document in the external (caller) system (Guid).
Amountrequireddecimal number
A document’s amount.
DocumentNorequiredstring
A document’s number
SourceAccountNumberrequiredstring
A sender’s account in IBAN format.
BeneficiaryAccountNumberrequiredstring
A recipient’s account. Only IBAN format is allowed for transfers to the Bank of Georgia or other banks in the national currency. A treasury code for the transfers to the National Treasury. An account ID in an existing format for the transfers in the foreign currency.
BeneficiaryBankCodeoptionalstring
An RTGS code of a recipient Bank.
BeneficiaryInnoptionalstring, max-length: 11
An Identification Number for individuals; an Identification Code for legal entities.
CheckInnoptionalstring
Used to indicate whether the compatibility of a receiver’s account to the Identification Code should be checked when transferring to the Bank of Georgia. Can take one of the two values:
TRUE
– An additional compatibility check of the account number by the identification code should take place. If the account number does not match the account numbers related to that identification code - an error will be returned.FALSE
– A transfer will be checked in a standard way. When transferring to another bank, this parameter should be always set toFalse
.
BeneficiaryNameoptionalstring
A recipient’s name.
AdditionalInformationoptionalstring
An additional info. Is not used for transfers in a national currency.
- JSON
- XML
POST api/documents/foreign
Content-Type: application/json
[
{
"Charges": "sample string 1",
"ComissionAccountNumber": "sample string 2",
"BeneficiaryBankName": "sample string 3",
"IntermediaryBankCode": "sample string 4",
"IntermediaryBankName": "sample string 5",
"PaymentDetail": "sample string 6",
"ValueDate": "2021-06-17T12:03:37.4722861+04:00",
"BeneficiaryRegistrationCountryCode": "sample string 8",
"BeneficiaryActualCountryCode": "sample string 9",
"RecipientAddress": "sample string 10",
"RecipientCity": "sample string 11",
"RegReportingValue": "sample string 12",
"UniqueId": "c6b8cc64-072d-4849-9b7a-a40dc5faa3af",
"Amount": 14.0,
"Currency": "sample string 15",
"DocumentNo": "sample string 16",
"SourceAccountNumber": "sample string 17",
"BeneficiaryAccountNumber": "sample string 18",
"BeneficiaryBankCode": "sample string 19",
"BeneficiaryInn": "sample string 20",
"CheckInn": true,
"BeneficiaryName": "sample string 22",
"AdditionalInformation": "sample string 23"
},
{
"Charges": "sample string 1",
"ComissionAccountNumber": "sample string 2",
"BeneficiaryBankName": "sample string 3",
"IntermediaryBankCode": "sample string 4",
"IntermediaryBankName": "sample string 5",
"PaymentDetail": "sample string 6",
"ValueDate": "2021-06-17T12:03:37.4722861+04:00",
"BeneficiaryRegistrationCountryCode": "sample string 8",
"BeneficiaryActualCountryCode": "sample string 9",
"RecipientAddress": "sample string 10",
"RecipientCity": "sample string 11",
"RegReportingValue": "sample string 12",
"UniqueId": "c6b8cc64-072d-4849-9b7a-a40dc5faa3af",
"Amount": 14.0,
"Currency": "sample string 15",
"DocumentNo": "sample string 16",
"SourceAccountNumber": "sample string 17",
"BeneficiaryAccountNumber": "sample string 18",
"BeneficiaryBankCode": "sample string 19",
"BeneficiaryInn": "sample string 20",
"CheckInn": true,
"BeneficiaryName": "sample string 22",
"AdditionalInformation": "sample string 23"
}
]
POST api/documents/foreign
Content-Type: application/xml
<ArrayOfForeignPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CIBApi.Models">
<ForeignPayment>
<AdditionalInformation>sample string 23</AdditionalInformation>
<Amount>14</Amount>
<BeneficiaryAccountNumber>sample string 18</BeneficiaryAccountNumber>
<BeneficiaryBankCode>sample string 19</BeneficiaryBankCode>
<BeneficiaryInn>sample string 20</BeneficiaryInn>
<BeneficiaryName>sample string 22</BeneficiaryName>
<CheckInn>true</CheckInn>
<Currency>sample string 15</Currency>
<DocumentNo>sample string 16</DocumentNo>
<SourceAccountNumber>sample string 17</SourceAccountNumber>
<UniqueId>c6b8cc64-072d-4849-9b7a-a40dc5faa3af</UniqueId>
<BeneficiaryActualCountryCode>sample string 9</BeneficiaryActualCountryCode>
<BeneficiaryBankName>sample string 3</BeneficiaryBankName>
<BeneficiaryRegistrationCountryCode>sample string 8</BeneficiaryRegistrationCountryCode>
<Charges>sample string 1</Charges>
<ComissionAccountNumber>sample string 2</ComissionAccountNumber>
<IntermediaryBankCode>sample string 4</IntermediaryBankCode>
<IntermediaryBankName>sample string 5</IntermediaryBankName>
<PaymentDetail>sample string 6</PaymentDetail>
<RecipientAddress>sample string 10</RecipientAddress>
<RecipientCity>sample string 11</RecipientCity>
<RegReportingValue>sample string 12</RegReportingValue>
<ValueDate>2021-06-17T12:03:37.4722861+04:00</ValueDate>
</ForeignPayment>
<ForeignPayment>
<AdditionalInformation>sample string 23</AdditionalInformation>
<Amount>14</Amount>
<BeneficiaryAccountNumber>sample string 18</BeneficiaryAccountNumber>
<BeneficiaryBankCode>sample string 19</BeneficiaryBankCode>
<BeneficiaryInn>sample string 20</BeneficiaryInn>
<BeneficiaryName>sample string 22</BeneficiaryName>
<CheckInn>true</CheckInn>
<Currency>sample string 15</Currency>
<DocumentNo>sample string 16</DocumentNo>
<SourceAccountNumber>sample string 17</SourceAccountNumber>
<UniqueId>c6b8cc64-072d-4849-9b7a-a40dc5faa3af</UniqueId>
<BeneficiaryActualCountryCode>sample string 9</BeneficiaryActualCountryCode>
<BeneficiaryBankName>sample string 3</BeneficiaryBankName>
<BeneficiaryRegistrationCountryCode>sample string 8</BeneficiaryRegistrationCountryCode>
<Charges>sample string 1</Charges>
<ComissionAccountNumber>sample string 2</ComissionAccountNumber>
<IntermediaryBankCode>sample string 4</IntermediaryBankCode>
<IntermediaryBankName>sample string 5</IntermediaryBankName>
<PaymentDetail>sample string 6</PaymentDetail>
<RecipientAddress>sample string 10</RecipientAddress>
<RecipientCity>sample string 11</RecipientCity>
<RegReportingValue>sample string 12</RegReportingValue>
<ValueDate>2021-06-17T12:03:37.4722861+04:00</ValueDate>
</ForeignPayment>
</ArrayOfForeignPayment>
Response
UniqueIdglobally unique identifier
An unique ID in the external system (Guid).
UniqueKeyinteger
An unique ID of the document in the business online.
ResultCodeinteger
A result code of an operation. (With a link to the ResultCode page). result code
Matchdecimal number
For the internal transfers a matched coefficient of provided recipient name. For legal entities a match of an owner of a provided IBAN to the entity name is being checked, while for the individuals - to the name and surname. A match coefficient in percent will be shown as a result of such a comparison.
- JSON
- XML
[
{
"UniqueId": "7afaebef-5c0a-4876-aa47-13370f16fc8c",
"UniqueKey": 2,
"ResultCode": 1,
"Match": 1.0
},
{
"UniqueId": "7afaebef-5c0a-4876-aa47-13370f16fc8c",
"UniqueKey": 2,
"ResultCode": 1,
"Match": 1.0
}
]
<ArrayOfDocumentKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CIBApi.Models">
<DocumentKey>
<Match>1</Match>
<ResultCode>1</ResultCode>
<UniqueId>7afaebef-5c0a-4876-aa47-13370f16fc8c</UniqueId>
<UniqueKey>2</UniqueKey>
</DocumentKey>
<DocumentKey>
<Match>1</Match>
<ResultCode>1</ResultCode>
<UniqueId>7afaebef-5c0a-4876-aa47-13370f16fc8c</UniqueId>
<UniqueKey>2</UniqueKey>
</DocumentKey>
</ArrayOfDocumentKey>