Skip to content

Parse address

/v2/address
/v2/address

Deprecation

The GET method of this endpoint will soon be deprecated. We recommend using the POST method instead.

Target audience: Developers

Release version: 4.7.5

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/v2/address
Production https://backend.worldoftulo.com/external/api/v2/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 POST \
  --url https://payway-api.stage.adeprimo.se/external/api/v2/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

"item": {
  // Payway Address // 
}   

A successful response item will contain a Payway Address.

Errors

This API uses the common error conventions of the Payway API

See common error responses