Parse address

/v1/address

Target audience: Developers

Release version: 4.4.6

Parse address

Introduction

This endpoint parses an address to the internally used format in Payway.

URI

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v1/address
Production	https://backend.worldoftulo.com/external/api/v1/address

Requirements

Identity	Scope
No	/external/address/r

Parameters

Field	Required	Type	Description
first_name	Required	String	The address's first name. Size range: ..1024
last_name	Required	String	The address's last name. Size range: ..1024
zip_code	Required	String	The address's zip code. Size: ..1024
city	Required	String	The address's city name. Size: ..1024
country_code	Required	String	The address's country code. Size: ..1024
street_address	Required	String	The address's street. Size: ..1024

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/address \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \
  --header 'content-type: application/json' \
  --data '{
            "first_name": "Adeprimo",
            "last_name": "Service",
            "zip_code": "65100",
            "city": "Vaasa",
            "country_code": "FI",
            "street_address": "Fakeaddress 123"
          }'

Example Response

HTTP 200 OK
{
    "first_name": "Adeprimo",
    "last_name": "Service",
    "zip_code": "65100",
    "city": "Vaasa",
    "country_code": "FI",
    "street": "Fakeaddress",
    "building": "123",
    "staircase": null,
    "apartment": null,
    "apartment_number": null
}

Errors

This API uses the common error conventions of the Payway API

See common error responses