Nordhealth / Provet Pay API documentation (1.0.0)

Download OpenAPI specification:Download

This documentation is dynamically generated.

payment-links

retrievePaymentLink

Get payment link by id

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": "string",
"shopper": "string",
"department": "string",
"store": "string",
"currency": "str",
"description": "string",
"email": "user@example.com",
"expires": "2019-08-24T14:15:22Z",
"phone": "string",
"sent": "string",
"status": "active",
"meta": { },
"payment_url": "http://example.com",
"allowed_payment_methods": "string",
"blocked_payment_methods": "string"
}

retrievePaymentLinkPspStatus

Get the real time status from the PSP of the payment link. Notice: a proper notification is still sent even if using this endpoint to check the real time status.

path Parameters

required

string

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"psp_reference": "string",
"status": "active"
}

createPaymentLink

Create a payment link

Returns url to a payment link page.

if allowed_payment_methods and blocked_payment_methods are both set, blocked_payment_methods will be ignored. Some optional fields like payment_details are needed for specific payment methods (e.g. Klarna)

Request Body schema: application/json

amount required	string <decimal> decimal places <= 2 [ -10000000000 .. 10000000000 ]
shopper	string ERN. Is used e.g. for shopper payment token identification
department required	string ERN
currency required	string Enum: "EUR" "USD" "CAD" "GBP" "DKK" "SEK" "NOK" "ISK" "CZK" "CHF" "HRK" "RON" "PLN" "HUF" "BGN"
description	string <= 280 characters
locale	string E.g. `en-US`. Will be used to display payment link page in correct language.
email	string or null <email> <= 254 characters
expires	string <date-time> Link expiration date. Set in ISO format e.g. `2023-10-18T14:30`. Alternative to `duration` parameter.
phone	string or null <= 128 characters
meta	string or null Metadata json object which will be included in notifications regarding the payment. E.g. `{"invoice_id": 58382, "transaction_id": 33964}`
recurring_model	string Enum: "subscription" "one-off"
tokenization_meta	string Metadata json object which will be included in notifications regarding the tokenization. E.g. `{"health_plan": 1}`
duration	integer >= 1 Link expiration in minutes. e.g. `2880` for two days. Alternative to `expires` parameter.
tokenize	string Default: "no" Enum: "yes" "no" "ask" Save payment method as a token to be used e.g. as a recurring payment method in the future.
payment_details	string or null Details of the payment (individual items with prices). Needed e.g. with Klarna. Example: { "line_items": [ { "id": "Item xxx", "quantity": 1, "tax_amount": "0.97", "description": "Massage vaccine.", "tax_percentage": "24.00", "amount_excluding_tax": "4.03", "amount_including_tax": "5.00" } ] }
allowed_payment_methods	Array of strings Payment method list e.g `['mc', 'visa']`.
blocked_payment_methods	Array of strings Payment method list e.g `['mc', 'visa']`.
show_remove_payment_method_button	boolean Default: false Allow user to remove stored payment methods in payment link page.
return_url	string <uri> ^(?:[a-z0-9.+-])://(?:[^\s:@/]+(?::[^\s:@/]... URL to redirect to after successful payment.
theme_id	string

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"shopper": "string",
"department": "string",
"currency": "EUR",
"description": "string",
"locale": "string",
"email": "user@example.com",
"expires": "2019-08-24T14:15:22Z",
"phone": "string",
"meta": "string",
"recurring_model": "subscription",
"tokenization_meta": "string",
"duration": 1,
"tokenize": "yes",
"payment_details": "string",
"allowed_payment_methods": ["string"
],
"blocked_payment_methods": ["string"
],
"show_remove_payment_method_button": false,
"return_url": "http://example.com",
"theme_id": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": "string",
"shopper": "string",
"department": "string",
"store": "string",
"currency": "str",
"description": "string",
"email": "user@example.com",
"expires": "2019-08-24T14:15:22Z",
"phone": "string",
"sent": "string",
"status": "active",
"meta": { },
"payment_url": "http://example.com",
"allowed_payment_methods": "string",
"blocked_payment_methods": "string"
}

partialUpdatePaymentLink

Update payment link expiration date.

path Parameters

required

string

Request Body schema: application/json

expires	string <date-time> Link expiration date. Set in ISO format e.g. `2023-10-18T14:30`. Alternative to `duration` parameter.
duration	integer >= 1 Link expiration in minutes. e.g. `2880` for two days. Alternative to `expires` parameter.

Responses

Request samples

Payload

Content type

application/json

{"expires": "2019-08-24T14:15:22Z",
"duration": 1
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": "string",
"shopper": "string",
"department": "string",
"store": "string",
"currency": "str",
"description": "string",
"email": "user@example.com",
"expires": "2019-08-24T14:15:22Z",
"phone": "string",
"sent": "string",
"status": "active",
"meta": { },
"payment_url": "http://example.com",
"allowed_payment_methods": "string",
"blocked_payment_methods": "string"
}

partialUpdatePaymentLinkCancel

Force expiry/cancellation of payment link

path Parameters

required

string

Request Body schema: application/json

object (PaymentLinkCancel)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

tokenizations

listTokenizations

query Parameters

shopper required	string shopper
meta	string meta

Responses

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "requested",
"meta": { },
"created": "2019-08-24T14:15:22Z",
"details": { },
"token": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instrument_type": "string",
"instrument_summary": "stri",
"issuer_country": "st",
"brand": "string",
"expiration": "2019-08-24",
"label": "string"
}
}
]

destroyTokenization

path Parameters

required

string

Responses

info

listERNs

Endpoint for testing the API.

Responses

Response samples

Content type

application/json

{ }

payment-requests

createRefundRequest

Request Body schema: application/json

original_transaction required	string
amount required	string <decimal> decimal places <= 2 [ -10000000000 .. 10000000000 ]
currency required	string <= 3 characters
merchant_reason	string <= 250 characters
meta	string or null

Responses

Request samples

Payload

Content type

application/json

{"original_transaction": "string",
"amount": "string",
"currency": "str",
"merchant_reason": "string",
"meta": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"websocket_url": "string",
"original_transaction": "string",
"amount": "string",
"currency": "str",
"merchant_reason": "string",
"meta": "string",
"transaction": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"description": "string",
"code": "string",
"metadata": { },
"status": "active",
"payout_speed": "STANDARD",
"payout_schedule": "DEFAULT",
"payout_schedule_reason": "string",
"is_own_liable": true,
"account_holder": "string"
},
"account_holder": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"company": "string",
"partner": {"identifier": "string",
"display_name": "string"
}
},
"payment_request": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "payment",
"subcategory": "payment-pos",
"channel": "POS",
"recurring_model": "subscription",
"psp_reference": "string",
"tender_reference": "string",
"service_id": "string",
"amount": "string",
"merchant_reason": "string",
"meta": { },
"currency": "str",
"status": "created",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"creator_ern": "string",
"creator_user_agent": "string",
"creator_ip": "string",
"pos_mode": "default",
"psp_response": "string",
"partner": 0,
"account": "string",
"store": "string",
"department": "string",
"merchant_account": 0,
"terminal": "string",
"payment_token": "string",
"original_transaction": "string",
"shopper": "string",
"payment_link": "string"
},
"refundable_amount": "string",
"payout_psp_reference": "string",
"category": "payment",
"subcategory": "payment-pos",
"channel": "POS",
"result": "pending",
"reversal_type": "string",
"reversal_reason": "string",
"merchant_reason": "string",
"error_condition": "string",
"psp_refusal_reason": "string",
"refusal_reason": "string",
"refusal_reason_code": -2147483648,
"message": "string",
"psp_reference": "string",
"psp_timestamp": "2019-08-24T14:15:22Z",
"psp_result": "string",
"tender_reference": "string",
"amount": "string",
"currency": "str",
"extra_costs": "string",
"date": "2019-08-24",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"instrument_type": "string",
"instrument_summary": "stri",
"instrument_issuer_country": "st",
"instrument_brand": "string",
"instrument_expiration": "2019-08-24",
"avs_result": "string",
"should_retry": "yes",
"shopper_country": "st",
"partner": 0,
"merchant_account": 0,
"parent": "string",
"reversed": "string",
"payment_link": "string",
"agreement_version": "string"
}
}

createTokenPaymentRequest

Request Body schema: application/json

amount required	string <decimal> decimal places <= 2 [ -10000000000 .. 10000000000 ]
currency required	string Enum: "EUR" "USD" "CAD" "GBP" "DKK" "SEK" "NOK" "ISK" "CZK" "CHF" "HRK" "RON" "PLN" "HUF" "BGN"
meta	string or null
department required	string ERN
shopper required	string ERN
payment_token	string or null
recurring_model	string Enum: "subscription" "one-off"

Responses

Request samples

Payload

Content type

application/json

{"amount": "string",
"currency": "EUR",
"meta": "string",
"department": "string",
"shopper": "string",
"payment_token": "string",
"recurring_model": "subscription"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "in-progress",
"transaction": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"description": "string",
"code": "string",
"metadata": { },
"status": "active",
"payout_speed": "STANDARD",
"payout_schedule": "DEFAULT",
"payout_schedule_reason": "string",
"is_own_liable": true,
"account_holder": "string"
},
"account_holder": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"company": "string",
"partner": {"identifier": "string",
"display_name": "string"
}
},
"payment_request": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "payment",
"subcategory": "payment-pos",
"channel": "POS",
"recurring_model": "subscription",
"psp_reference": "string",
"tender_reference": "string",
"service_id": "string",
"amount": "string",
"merchant_reason": "string",
"meta": { },
"currency": "str",
"status": "created",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"creator_ern": "string",
"creator_user_agent": "string",
"creator_ip": "string",
"pos_mode": "default",
"psp_response": "string",
"partner": 0,
"account": "string",
"store": "string",
"department": "string",
"merchant_account": 0,
"terminal": "string",
"payment_token": "string",
"original_transaction": "string",
"shopper": "string",
"payment_link": "string"
},
"refundable_amount": "string",
"payout_psp_reference": "string",
"category": "payment",
"subcategory": "payment-pos",
"channel": "POS",
"result": "pending",
"reversal_type": "string",
"reversal_reason": "string",
"merchant_reason": "string",
"error_condition": "string",
"psp_refusal_reason": "string",
"refusal_reason": "string",
"refusal_reason_code": -2147483648,
"message": "string",
"psp_reference": "string",
"psp_timestamp": "2019-08-24T14:15:22Z",
"psp_result": "string",
"tender_reference": "string",
"amount": "string",
"currency": "str",
"extra_costs": "string",
"date": "2019-08-24",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"instrument_type": "string",
"instrument_summary": "stri",
"instrument_issuer_country": "st",
"instrument_brand": "string",
"instrument_expiration": "2019-08-24",
"avs_result": "string",
"should_retry": "yes",
"shopper_country": "st",
"partner": 0,
"merchant_account": 0,
"parent": "string",
"reversed": "string",
"payment_link": "string",
"agreement_version": "string"
},
"amount": "string",
"currency": "EUR",
"meta": "string",
"shopper": "string",
"payment_token": "string",
"websocket_url": "string",
"recurring_model": "subscription"
}