POST api/v1/transaction/cancel-cross-border-transaction

Request Information

URI Parameters

None.

Body Parameters

CancelCrossBorderTransferRequest
NameDescriptionTypeAdditional information
SourceCountryId

string

Matching regular expression pattern: ^[A-Za-z0-9./-]+$

SourceAccountNumber

string

Matching regular expression pattern: ^[A-Za-z0-9./-]+$

SourceAmount

decimal number

None.

CommissionAmount

decimal number

None.

VatAmount

decimal number

None.

SmsAmount

decimal number

None.

DestinationCountryId

string

Matching regular expression pattern: ^[A-Za-z0-9./-]+$

Narration

string

None.

InitiatingBranchCode

string

None.

ClientReferenceId

string

Matching regular expression pattern: (^(?=.{4,50}$)([ A-Za-z0-9._|/-]+$))

TransactionType

string

Matching regular expression pattern: ^[A-Za-z0-9./-]+$

RequestId

string

Required

Matching regular expression pattern: (^(?=.{4,50}$)([ A-Za-z0-9._|/-]+$))

CountryId

string

Required

Request Formats

application/json, text/json

Sample:
{
  "SourceCountryId": "sample string 1",
  "SourceAccountNumber": "sample string 2",
  "SourceAmount": 3.0,
  "CommissionAmount": 4.0,
  "VatAmount": 5.0,
  "SmsAmount": 6.0,
  "DestinationCountryId": "sample string 7",
  "Narration": "sample string 8",
  "InitiatingBranchCode": "sample string 9",
  "ClientReferenceId": "sample string 10",
  "TransactionType": "sample string 11",
  "RequestId": "sample string 12",
  "CountryId": "sample string 13"
}

application/xml, text/xml

Sample:
<CancelCrossBorderTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstBank.FIBridge.CoreObject.DataTransferObjects">
  <CountryId>sample string 13</CountryId>
  <RequestId>sample string 12</RequestId>
  <ClientReferenceId>sample string 10</ClientReferenceId>
  <CommissionAmount>4</CommissionAmount>
  <DestinationCountryId>sample string 7</DestinationCountryId>
  <InitiatingBranchCode>sample string 9</InitiatingBranchCode>
  <Narration>sample string 8</Narration>
  <SmsAmount>6</SmsAmount>
  <SourceAccountNumber>sample string 2</SourceAccountNumber>
  <SourceAmount>3</SourceAmount>
  <SourceCountryId>sample string 1</SourceCountryId>
  <TransactionType>sample string 11</TransactionType>
  <VatAmount>5</VatAmount>
</CancelCrossBorderTransferRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.