Ecster Pay Link API
Live and test environment
Ecsters REST resources for the live and test environment reside under different host addresses:
Live: https://secure.ecster.se/rest/public/v1/paymentlinks
Test: https://labs.ecster.se/rest/public/v1/paymentlinks
Create payment link
By using this call you create a payment link.
| Request Parameters | Description | |||
| locale (object) [1] | Settings for language and formatting. Not to be used to determine customer physical location. | |||
| language (string) [1] | In ISO 639-1 format, “sv”, “en”, “no", “da”, “fi”. Fall back for “no“ and “da“ = “sv“(1) “en“(2). Fall back for all other languages = “en“. | |||
| country (string) [1] | In ISO 3166-1 alpha-2 format, e.g. “SE”, “GB”, “NO”, “DK”, “FI”. | |||
| parameters (object) [1] | ||||
| shopTermsUrl (string) [0-1] | Url to shop terms stating terms and conditions. | |||
| returnUrl (string) [0-1] | Return URL to your website after successful order e.g. https://www.ecster.se | |||
| sendLink (boolean) [1] | If Ecster will send out Ecster Pay Link (if true email and/or cellular is mandatory in contactinfo object). If both email and cellular are submitted email will be used. | |||
| inPerson (boolean) [1] | True if both consumer and merchant sales person are present, false otherwise (if true, shopTermsUrl is not mandatory. If false, shopTermsUrl is mandatory). | |||
| validTo (timestamp) [0-1] | Sets how long the Ecster Pay Link url should be valid. | |||
| defaultDeliveryCountry (string) [0-1] | Sets the default delivery country in Ecster Pay when consumer chooses to use another delivery adress. ISO 3166-1 alpha-2 format, e.g. “SE”, “GB”, “NO”, “DK”, “FI”. | |||
| deliveryMethods [0-*] | If sent, Ecster displays the deliverymethod on the confirmation page. | |||
| id (string) [1] | Your id for specific delivery method. | |||
| name (string) [1] | The name for the specific delivery method. | |||
| description (string) [0-1] | Information about the specific delivery method. | |||
| price (amount) [1] | Price for delivery method. | |||
| selected (boolean) [0-1] | If this delivery method is selected. | |||
| cart [1] | Object describing a cart. The cart object has the following fields: | |||
| amount (amount) [1] | Total amount on this cart. Amount must match the sum of the amounts and discounts in cart rows. | |||
| currency (currency) [1] | Currency on cart. | |||
| message (string) [0-1] | Message to consumer, shown on invoice. | |||
| rows [1-*] | Object describing a row in a cart. The row object has the following fields: | |||
| name (string) [1] | Name of row. | |||
| quantity (double) | ||||
| unitAmount (amount) [1] | Unit amount is including vat amount. | |||
| vatRate (string) [0-1] | Vat rate, sent as integer including two decimals, i.e. 25% is represented as 2500. | |||
| partNumber (string) [0-1] | Part number on row. | |||
| description (string) [0-1] | ||||
| unit (string) [0-1] | ||||
| discountAmount (amount) [0-1] | Discount on the order line, submitted as an integer and can not be greater than the total order amount. | |||
| serials (string) [0-*] | ||||
| fee (boolean) [0-1] | true if the row is a fee. Default = false. | |||
| provided (boolean) [1] read only | true if row has been added by Ecster. Will be set to true when invoice fee has been added automatically, else false. | |||
| orderReference (string) [1] | Merchant’s order reference, max 22 characters. | |||
| consumer [0-1] | Object describing an identified consumer. The consumer object has the following fields: | |||
| name (name) [0-1] | ||||
| firstName (string) [0-1] | ||||
| lastName (string) [0-1] | ||||
| title (string) [0-1] | ||||
| address (address) [0-1] | Object describing an address. The address object has the following fields: | |||
| line1 (string) [0-1] | Street name and number. Applicable for all addresses except German("DE") and Austria("AT"). | |||
| streetName (string) [0-1] | Applicable for addresses in German("DE") and Austria("AT"). | |||
| streetNumber (string) [0-1] | Applicable for addresses in German("DE") and Austria("AT"). | |||
| line2 (string) [0-1] | C/O address, Company address field. Applicable for all addresses. | |||
| city (string) [0-1] | ||||
| zip (string) [0-1] | ||||
| province (string) [0-1] | Used when applicable for e.g. Region, State, Province. Mandatory for United States ("US"). | |||
| country (string) [0-1] | ISO 3166-1 alpha-2 format. | |||
| contactInfo (contactInfo) [0-1] | Contact information to consumer. | |||
| email (string) [0-1] | ||||
| cellular (object) [0-1] | Cellular phone number with country code. | |||
| country (string) [0-1] | Country code for cellular. Specify country code with “+”, e.g. “+46” or “0046” for Sweden. | |||
| number (string) [0-1] | Cellular phone number. Specify number including area code but without country code. | |||
| phone (object) [0-1] | Phone number with country code. | |||
| country (string) [0-1] | Country code for phone. Specify country code with “+”, e.g. “+46” or “0046” for Sweden. | |||
| number (string) [0-1] | Phone number. Specify number including area code but without country code. | |||
| notificationUrl (string) [0-1] | URL for status change notifications. See details here | |||
| platform (object) [0-1] | E-Commerce Platform information. | |||
| reference (string) [1] | Reference provided by Ecster. | |||
| info (string) [0-1] | Platform name and version. | |||
| tags (string) [0-*] |
Provide tags for statistics purposes. | |||
| countryCode (string) [0-1] | Sets country for the consumer. ISO 3166-1 alpha-2 format, e.g. “SE”, “GB”, “NO”, “DK”, “FI”. | |||
JSON example
Post
/rest/public/v1/paymentlinks/
Request
Headers
x-api-key: JKN675aVeMR9Mleh786FGf2ff7T1okmH6 (example)
x-merchant-key: 10569832 (example)
Content-Type: application/jsonBody
{
"locale": {
"language": "sv",
"country": "SE"
},
"parameters" : {
"sendLink" : true,
"inPerson" : false,
"validTo": "2019-10-30T11:05:01+01:00",
"shopTermsUrl": "https://myCoolStore.com/terms/storeTerms.html",
"returnUrl" : "https://myCoolStore.com/return/to/page.html"
},
"deliveryMethods": [
{
"id": "dev_id_123",
"name": "Shipping",
"description": "Shipping small",
"price": 120000,
"selected": false
},
{
"id": "dev_id_124",
"name": "Shipping fast",
"description": "Shipping fast",
"price": 100000,
"selected": true
}
],
"cart": {
"amount": 266900,
"currency": "SEK",
"message": "Cart only for you",
"rows": [
{
"partNumber": "264275-0044_345",
"name": "Adidas Stan Smith",
"description": "Vit storlek 42",
"quantity": 1.0,
"unitAmount": 75000,
"unit": "st",
"vatRate": 2500,
"discountAmount": 0,
"serials": [
"951358"
]
},
{
"partNumber": "264275-0044_346",
"name": "T-shirt",
"description": "Green",
"quantity": 1.0,
"unitAmount": 29900,
"unit": "st",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_347",
"name": "Socks",
"description": "White",
"quantity": 3.0,
"unitAmount": 9900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_348",
"name": "Boots",
"description": "Premium",
"quantity": 1.0,
"unitAmount": 99900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_349",
"name": "Skates",
"description": "Ice skates",
"quantity": 1.0,
"unitAmount": 19900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_350",
"name": "Icepicks",
"description": "Hacketihack",
"quantity": 1.0,
"unitAmount": 12500,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
}
]
},
"orderReference": "OrderRef_123123",
"consumer": {
"name": {
"firstName": "Arne",
"lastName": "Anka",
"title": "mr"
},
"address": {
"line1": "Ankeborgsgatan 12",
"zip": "777 77",
"city": "Ankeborg",
"country": "Sweden"
},
"contactInfo": {
"email": "test@ecster.se",
"cellular": {
"number": "700000000",
"country": "+46"
}
}
},
"notificationUrl": "www.myCoolStore.com/notify/page.html",
"platform": {
"reference": "2cc5c43d-fb92-472f-828a-1a5ad703d512",
"info": "info about version"
},
"tags":["testTagType1:testTagMsg1","testTagType2:testTagMsg2"]
}Response 201 Created
Body
{
"paymentLink": {
"key": "7125D0126E4BC49EB15086709E08B400",
"payLinkUrl": "https://secure1.ft.ecster.se/pay/links/?7125D0126E4BC49EB15086709E08B400",
"locale": {
"language": "sv",
"country": "SE"
},
"deliveryMethods": [
{
"id": "dev_id_123",
"name": "Shipping",
"description": "Shipping small",
"price": 120000,
"selected": false
},
{
"id": "dev_id_124",
"name": "Shipping fast",
"description": "Shipping fast",
"price": 100000,
"selected": true
}
],
"cart": {
"amount": 266900,
"currency": "SEK",
"rows": [
{
"name": "Adidas Stan Smith",
"quantity": 1,
"unitAmount": 75000,
"vatRate": 2500,
"partNumber": "264275-0044_345",
"description": "Vit storlek 42",
"unit": "st",
"discountAmount": 0,
"serials": [
"951358"
]
},
{
"name": "T-shirt",
"quantity": 1,
"unitAmount": 29900,
"vatRate": 2500,
"partNumber": "264275-0044_346",
"description": "Green",
"unit": "st",
"discountAmount": 0
},
{
"name": "Socks",
"quantity": 3,
"unitAmount": 9900,
"vatRate": 2500,
"partNumber": "264275-0044_347",
"description": "White",
"unit": "par",
"discountAmount": 0
},
{
"name": "Boots",
"quantity": 1,
"unitAmount": 99900,
"vatRate": 2500,
"partNumber": "264275-0044_348",
"description": "Premium",
"unit": "par",
"discountAmount": 0
},
{
"name": "Skates",
"quantity": 1,
"unitAmount": 19900,
"vatRate": 2500,
"partNumber": "264275-0044_349",
"description": "Ice skates",
"unit": "par",
"discountAmount": 0
},
{
"name": "Icepicks",
"quantity": 1,
"unitAmount": 12500,
"vatRate": 2500,
"partNumber": "264275-0044_350",
"description": "Hacketihack",
"unit": "par",
"discountAmount": 0
}
],
"message": "Cart only for you"
},
"orderReference": "OrderRef_123123",
"consumer": {
"name": {
"firstName": "Arne",
"lastName": "Anka",
"title": "mr"
},
"address": {
"line1": "Ankeborgsgatan 12",
"city": "Ankeborg",
"zip": "777 77",
"country": "Sweden"
},
"contactInfo": {
"email": "test@ecster.se",
"cellular": {
"country": "+46",
"number": "700000000"
}
}
},
"notificationUrl": "www.myCoolStore.com/notify/page.html",
"platform": {
"reference": "2cc5c43d-fb92-472f-828a-1a5ad703d512",
"info": "info about version"
},
"tags": [
"APIv1",
"testTagType1:testTagMsg1",
"testTagType2:testTagMsg2"
],
"parameters": {
"returnUrl": "https://myCoolStore.com/return/to/page.html",
"shopTermsUrl": "https://myCoolStore.com/terms/storeTerms.html",
"sendLink": true,
"inPerson": false,
"validTo": "2019-10-30T11:05:01+01:00"
}
}
}Data types
= Mandatory
= Optional
Response
In the response you will recieve the
| Response parameters | Description |
| key | cartKey |
| link url | url |
| The entire request body | See section Create Cart API |
Update payment link
| Query paramters | Description | |||
| key | Current payment link key | |||
| Request Parameters | Description | |||
| locale (object) [1] | Settings for language and formatting. Not to be used to determine customer physical location. | |||
| language (string) [1] | In ISO 639-1 format, “sv”, “en”, “no", “da”, “fi”. Fall back for “no“ and “da“ = “sv“(1) “en“(2). Fall back for all other languages = “en“. | |||
| country (string) [1] | In ISO 3166-1 alpha-2 format, e.g. “SE”, “GB”, “NO”, “DK”, “FI”. | |||
| parameters (object) [1] | ||||
| shopTermsUrl (string) [0-1] | Url to shop terms stating terms and conditions. | |||
| returnUrl (string) [0-1] | Return URL to your website after successful order e.g. https://www.ecster.se | |||
| sendLink (boolean) [1] | If Ecster will send out Ecster Pay Link (if true, email and/or cellular is mandatory in contactinfo object). If both email and cellular are submitted email will be used. | |||
| inPerson (boolean) [1] | True if both consumer and merchant sales person are present, false otherwise (if true, shopTermsUrl is not mandatory. If false, shopTermsUrl is mandatory). | |||
| validTo (timestamp) [0-1] | Sets how long the Ecster Pay Link url should be valid. | |||
| deliveryMethods [0-*] | If sent, Ecster displays the deliverymethod on the confirmation page. | |||
| id (string) [1] | Your id for specific delivery method. | |||
| name (string) [1] | The name for the specific delivery method. | |||
| description (string) [0-1] | Information about the specific delivery method. | |||
| price (amount) [1] | Price for delivery method. | |||
| selected (boolean) [0-1] | If this delivery method is selected. | |||
| cart [1] | Object describing a cart. The cart object has the following fields: | |||
| amount (amount) [1] | Total amount on this cart. Amount must match the sum of the amounts and discounts in cart rows. | |||
| currency (currency) [1] | Currency on cart. | |||
| message (string) [0-1] | Message to consumer, shown on invoice. | |||
| rows [1-*] | Object describing a row in a cart. The row object has the following fields: | |||
| name (string) [1] | Name of row. | |||
| quantity (double) | ||||
| unitAmount (amount) [1] | Unit amount is including vat amount. | |||
| vatRate (string) [0-1] | Vat rate, sent as integer including two decimals, i.e. 25% is represented as 2500. | |||
| partNumber (string) [0-1] | Part number on row. | |||
| description (string) [0-1] | ||||
| unit (string) [0-1] | ||||
| discountAmount (amount) [0-1] | Discount on the order line, submitted as an integer and can not be greater than the total order amount. | |||
| serials (string) [0-*] | ||||
| fee (boolean) [0-1] | true if the row is a fee. Default = false. | |||
| provided (boolean) [1] read only | true if row has been added by Ecster. Will be set to true when invoice fee has been added automatically, else false. | |||
| orderReference (string) [1] | Merchant’s order reference, max 22 characters. | |||
| consumer [0-1] | Object describing an identified consumer. The consumer object has the following fields: | |||
| name (name) [0-1] | ||||
| firstName (string) [0-1] | ||||
| lastName (string) [0-1] | ||||
| title (string) [0-1] | ||||
| address (address) [0-1] | Object describing an address. The address object has the following fields: | |||
| line1 (string) [0-1] | Street name and number. Applicable for all addresses except German("DE") and Austria("AT"). | |||
| streetName (string) [0-1] | Applicable for addresses in German("DE") and Austria("AT"). | |||
| streetNumber (string) [0-1] | Applicable for addresses in German("DE") and Austria("AT"). | |||
| line2 (string) [0-1] | C/O address, Company address field. Applicable for all addresses. | |||
| city (string) [0-1] | ||||
| zip (string) [0-1] | ||||
| province (string) [0-1] | Used when applicable for e.g. Region, State, Province. Mandatory for United States ("US"). | |||
| country (string) [0-1] | ISO 3166-1 alpha-2 format. | |||
| contactInfo (contactInfo) [0-1] | Contact information to consumer. | |||
| email (string) [0-1] | ||||
| cellular (object) [0-1] | Cellular phone number with country code. | |||
| country (string) [0-1] | Country code for cellular. Specify country code with “+”, e.g. “+46” or “0046” for Sweden. | |||
| number (string) [0-1] | Cellular phone number. Specify number including area code but without country code. | |||
| phone (object) [0-1] | Phone number with country code. | |||
| country (string) [0-1] | Country code for phone. Specify country code with “+”, e.g. “+46” or “0046” for Sweden. | |||
| number (string) [0-1] | Phone number. Specify number including area code but without country code. | |||
| notificationUrl (string) [0-1] | URL for status change notifications. See details here | |||
| platform (object) [0-1] | E-Commerce Platform information. | |||
| reference (string) [1] | Reference provided by Ecster. | |||
| info (string) [0-1] | Platform name and version. | |||
| tags (string) [0-*] |
Provide tags for statistics purposes. | |||
JSON example
Put
/rest/public/v1/carts/<key>
Request
Headers
x-api-key: JKN675aVeMR9Mleh786FGf2ff7T1okmH6
x-merchant-key: 10569832
Content-Type: application/jsonBody
{
"locale": {
"language": "sv",
"country": "SE"
},
"parameters" : {
"sendLink" : true,
"inPerson" : false,
"validTo": "2020-10-30T11:05:01+01:00",
"shopTermsUrl": "https://myCoolStore.com/terms/storeTerms.html",
"returnUrl" : "https://myCoolStore.com/return/to/page.html"
},
"deliveryMethods": [
{
"id": "dev_id_123",
"name": "Shipping",
"description": "Shipping small",
"price": 120000,
"selected": false
},
{
"id": "dev_id_124",
"name": "Shipping fast",
"description": "Shipping fast",
"price": 100000,
"selected": true
}
],
"cart": {
"amount": 266900,
"currency": "SEK",
"message": "Cart only for you",
"rows": [
{
"partNumber": "264275-0044_345",
"name": "Adidas Stan Smith",
"description": "Vit storlek 42",
"quantity": 1.0,
"unitAmount": 75000,
"unit": "st",
"vatRate": 2500,
"discountAmount": 0,
"serials": [
"951358"
]
},
{
"partNumber": "264275-0044_346",
"name": "T-shirt",
"description": "Green",
"quantity": 1.0,
"unitAmount": 29900,
"unit": "st",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_347",
"name": "Socks",
"description": "White",
"quantity": 3.0,
"unitAmount": 9900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_348",
"name": "Boots",
"description": "Premium",
"quantity": 1.0,
"unitAmount": 99900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_349",
"name": "Skates",
"description": "Ice skates",
"quantity": 1.0,
"unitAmount": 19900,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
},
{
"partNumber": "264275-0044_350",
"name": "Icepicks",
"description": "Hacketihack",
"quantity": 1.0,
"unitAmount": 12500,
"unit": "par",
"vatRate": 2500,
"discountAmount": 0
}
]
},
"orderReference": "OrderRef_123123",
"consumer": {
"name": {
"firstName": "Arne",
"lastName": "Anka",
"title": "mr"
},
"address": {
"line1": "Ankeborgsgatan 12",
"zip": "777 77",
"city": "Ankeborg",
"country": "Sweden"
},
"contactInfo": {
"email": "test@ecster.se",
"cellular": {
"number": "700000000",
"country": "+46"
}
}
},
"notificationUrl": "www.myCoolStore.com/notify/page.html",
"platform": {
"reference": "2cc5c43d-fb92-472f-828a-1a5ad703d512",
"info": "info about version"
},
"tags":["testTagType1:testTagMsg1","testTagType2:testTagMsg2"]
}Response 201 Created
Body
{
"paymentLink": {
"key": "3B069E4C7580B7ABAC3610EACB368EA1",
"payLinkUrl": "https://secure1.ft.ecster.se/pay/links/?3B069E4C7580B7ABAC3610EACB368EA1",
"locale": {
"language": "sv",
"country": "SE"
},
"deliveryMethods": [
{
"id": "dev_id_123",
"name": "Shipping",
"description": "Shipping small",
"price": 120000,
"selected": false
},
{
"id": "dev_id_124",
"name": "Shipping fast",
"description": "Shipping fast",
"price": 100000,
"selected": true
}
],
"cart": {
"amount": 266900,
"currency": "SEK",
"rows": [
{
"name": "Adidas Stan Smith",
"quantity": 1,
"unitAmount": 75000,
"vatRate": 2500,
"partNumber": "264275-0044_345",
"description": "Vit storlek 42",
"unit": "st",
"discountAmount": 0,
"serials": [
"951358"
]
},
{
"name": "T-shirt",
"quantity": 1,
"unitAmount": 29900,
"vatRate": 2500,
"partNumber": "264275-0044_346",
"description": "Green",
"unit": "st",
"discountAmount": 0
},
{
"name": "Socks",
"quantity": 3,
"unitAmount": 9900,
"vatRate": 2500,
"partNumber": "264275-0044_347",
"description": "White",
"unit": "par",
"discountAmount": 0
},
{
"name": "Boots",
"quantity": 1,
"unitAmount": 99900,
"vatRate": 2500,
"partNumber": "264275-0044_348",
"description": "Premium",
"unit": "par",
"discountAmount": 0
},
{
"name": "Skates",
"quantity": 1,
"unitAmount": 19900,
"vatRate": 2500,
"partNumber": "264275-0044_349",
"description": "Ice skates",
"unit": "par",
"discountAmount": 0
},
{
"name": "Icepicks",
"quantity": 1,
"unitAmount": 12500,
"vatRate": 2500,
"partNumber": "264275-0044_350",
"description": "Hacketihack",
"unit": "par",
"discountAmount": 0
}
],
"message": "Cart only for you"
},
"orderReference": "OrderRef_123123",
"consumer": {
"name": {
"firstName": "Arne",
"lastName": "Anka",
"title": "mr"
},
"address": {
"line1": "Ankeborgsgatan 12",
"city": "Ankeborg",
"zip": "777 77",
"country": "Sweden"
},
"contactInfo": {
"email": "test@ecster.se",
"cellular": {
"country": "+46",
"number": "700000000"
}
}
},
"notificationUrl": "www.myCoolStore.com/notify/page.html",
"platform": {
"reference": "2cc5c43d-fb92-472f-828a-1a5ad703d512",
"info": "info about version"
},
"tags": [
"APIv1",
"testTagType1:testTagMsg1",
"testTagType2:testTagMsg2"
],
"parameters": {
"returnUrl": "https://myCoolStore.com/return/to/page.html",
"shopTermsUrl": "https://myCoolStore.com/terms/storeTerms.html",
"sendLink": true,
"inPerson": false,
"validTo": "2020-10-30T11:05:01+01:00"
}
}
}Data types
= Mandatory
= Optional
Response
In the response you will recieve the cart key and the body.
| Response parameters | Description |
| key | cartKey |
| payment link url | url |
| The entire request body | See section Update payment link API |
Change order reference API
This call changes the orderReference or sets it if it does not exist.
Search payment links
Search payment links will return a paginated result.
| Query parameter | Description |
| orderReference (string, 0-1, size max 64) | search for payment links having this order reference |
| cellular (string, 0-1) | search for payment links having a consumer with this mobile phone number |
| email: (string, 0-1) | search for payment links having a consumer with this email |
| createdfrom: (date, 0-1) | search for payment links created from this date and forward |
| status (string, 0-1) | Status on payment link ((OPEN, INVALID, ORDER_CREATED) |
| expiredTo (date, 0-1) | search for payment links which expires until the submission date |
| activefrom (date, 0-1) | search for payment links which are valid least to this date |
| offset (int, 0-1) | result offset, default 0 |
| limit (int, 0-1) | result limit, default 50 |
Search request
To search payment links, send the above paramters orderReference, status, cellular, email, createdfrom, expiredTo, activefrom, offset and limit via a server-side call to our REST API.
JSON example
Get
rest/public/v1/paymentlinks/?orderReference=<orderReference>&status=<status>&cellular=<cellular>&email=<email>&createdfrom=<createdfrom>&expiredTo=<expiredTo>&acriveFrom=<activeFrom>&offset=<offset>&limit=<limit>
Request
Headers
x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/jsonQuery parameters
status
string
Status on payment link (OPEN, INVALID, ORDER_CREATED)
orderReference
string
Merchant’s order reference for a payment link
cellular
string
Search for payment links having a consumer with this mobile phone number
email
string
createdFrom
date
Search for payment links created from this date and forward
expiredTo
date
Search for payment links which expires until the submission date
activeFrom
date
Search for payment links which are valid least to this date
paymentlink
int
result offset, default 0
line1
int
result limit, default 50
Body
Response 200 OK
Body
[
{
"key": "97E5909113BB4BE6881C28B78ED5EB7B",
"orderReference": "nyorder1",
"created": "2019-08-12+02:00",
"validTo": "2019-10-30T11:05:01+01:00",
"status": "OPEN",
"cellular": "700000000",
"email": "test@ecster.se",
"amount": 266900,
"currency": "SEK"
}
]Data types
= Mandatory
= Optional
Response
In the response you will recieve the following:
| Response parameters | Description | |||||||||
| key (key, 1) | key for a specific payment link order | |||||||||
| status (status, 1) | status on payment link | |||||||||
| orderReference (string, 0-1) | merchant’s payment link reference on order | |||||||||
| email (string, 0-1) | ||||||||||
| cellular (object, 0-1) | cellular phone number with country code | |||||||||
| amount (amount, 1) | amount on order | |||||||||
| currency (currency, 1) | currency on order | |||||||||
| created (timestamp, 1) | pyment link was created | |||||||||
| validTo (timestamp, 0-1) | time when payment link is valid | |||||||||
Delete payment link
Search payment links will return a paginated result.
| Query parameter | Description |
| key (string, 1) | key for the specific payment link |
Delete request
To delete a payment link, send the key query paramter, via a server-side call to our REST API.
JSON example
Get
rest/public/v1/paymentlinks/?orderReference=<orderReference>&status=<status>&cellular=<cellular>&email=<email>&createdfrom=<createdfrom>&expiredTo=<expiredTo>&acriveFrom=<activeFrom>&offset=<offset>&limit=<limit>
Request
Headers
x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/jsonQuery parameters
status
string
Status on payment link (OPEN, INVALID, ORDER_CREATED)
orderReference
string
Merchant’s order reference for a payment link
cellular
string
Search for payment links having a consumer with this mobile phone number
email
string
createdFrom
date
Search for payment links created from this date and forward
expiredTo
date
Search for payment links which expires until the submission date
activeFrom
date
Search for payment links which are valid least to this date
paymentlink
int
result offset, default 0
line1
int
result limit, default 50
Body
Response 200 OK
Body
[
{
"key": "97E5909113BB4BE6881C28B78ED5EB7B",
"orderReference": "nyorder1",
"created": "2019-08-12+02:00",
"validTo": "2019-10-30T11:05:01+01:00",
"status": "OPEN",
"cellular": "700000000",
"email": "test@ecster.se",
"amount": 266900,
"currency": "SEK"
}
]Data types
= Mandatory
= Optional
Response
In the response you will not recieve anything other then status is 200 No Content.