GET, POST | /Address |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Text | body | string | Yes | The Text is address code. |
Container | body | string | Yes | The Container is address Id. |
Type | body | string | Yes | The Type is type of addresss. |
CSR | body | string | No | The Csr of the application (if available). |
SourceCode | body | string | Yes | The SourceCode of the Adderess. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Successful | form | bool | No | Contains response status, details and errors. |
Csr | form | string | No | The Csr of the application (if available). |
RetrieveResult | form | IEnumerable<Capture_Interactive_Retrieve_v1_00_Results> | No | Contains the Adderess lookup Retrieve result when successful. |
FindResults | form | IEnumerable<Capture_Interactive_Find_v1_00_Results> | No | Contains the Adderess lookup Find result when successful. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
DomesticId | form | string | No | |
Language | form | string | No | |
LanguageAlternatives | form | string | No | |
Department | form | string | No | |
Company | form | string | No | |
SubBuilding | form | string | No | |
BuildingNumber | form | string | No | |
BuildingName | form | string | No | |
SecondaryStreet | form | string | No | |
Street | form | string | No | |
Block | form | string | No | |
Neighbourhood | form | string | No | |
District | form | string | No | |
City | form | string | No | |
Line1 | form | string | No | |
Line2 | form | string | No | |
Line3 | form | string | No | |
Line4 | form | string | No | |
Line5 | form | string | No | |
AdminAreaName | form | string | No | |
AdminAreaCode | form | string | No | |
Province | form | string | No | |
ProvinceName | form | string | No | |
ProvinceCode | form | string | No | |
PostalCode | form | string | No | |
CountryName | form | string | No | |
CountryIso2 | form | string | No | |
CountryIso3 | form | string | No | |
CountryIsoNumber | form | int | No | |
SortingNumber1 | form | string | No | |
SortingNumber2 | form | string | No | |
Barcode | form | string | No | |
POBoxNumber | form | string | No | |
Label | form | string | No | |
Type | form | string | No | |
DataLevel | form | string | No | |
Field1 | form | string | No | |
Field2 | form | string | No | |
Field3 | form | string | No | |
Field4 | form | string | No | |
Field5 | form | string | No | |
Field6 | form | string | No | |
Field7 | form | string | No | |
Field8 | form | string | No | |
Field9 | form | string | No | |
Field10 | form | string | No | |
Field11 | form | string | No | |
Field12 | form | string | No | |
Field13 | form | string | No | |
Field14 | form | string | No | |
Field15 | form | string | No | |
Field16 | form | string | No | |
Field17 | form | string | No | |
Field18 | form | string | No | |
Field19 | form | string | No | |
Field20 | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Type | form | string | No | |
Text | form | string | No | |
Highlight | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Address HTTP/1.1
Host: wp-cddws-test.worldpay.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Text":"String","Container":"String","Type":"String","CSR":"String","SourceCode":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Successful":false,"Csr":"String"}