• Documentation
  • API Reference
Overview

#Movepay Ecommerce API

The Movepay API ecommerce endpoints

Payment

#Create a new payment

This endpoint allows the creation of a new payment. It requires an API key for authorization and expects a payload containing the payment details. The response includes a payment token, which can be used for further operations.

#Headers

  • X-Api-Keyrequiredstring

    Authorization key

#Request Body

  • orderIdstring
  • amountnumber
  • moveIdstring
  • languageCodestring
  • successUrlstring
  • cancelUrlstring

#Responses

    • expires_atstring
    • redirect_urlstring
    • tokenstring

#Get payment qr code

This endpoint allows the creation of a new payment qr code. It requires a payment token and returns a qr code image. Image is in png format. This get request could be used to display the qr code directly, without the need to download it.

#path Parameters

  • tokenrequiredstring

#Responses

    No response specified

#Get payment url

This endpoint allows the creation of a new payment url. Use "redirect_url" to redirect user to payment page directly.

#path Parameters

  • tokenrequiredstring

#query Parameters

  • returnUrlrequiredstring

#Responses

    • expires_atstring
    • redirect_urlstring
    • tokenstring

#Get payment details

This endpoint allows to get payment details. It requires a payment token and returns the payment details.

#path Parameters

  • tokenrequiredstring

#Responses

    • orderIdstring
    • amountnumber
    • moveIdstring
    • languageCodestring
    • qrCodeUrlstring
    • deepLinkUrlstring
    • paymentIdstring
    • redirectUrlstring
    • dataobject

      Data about the payment

Overview
Payment
    Create a new paymentpostGet payment qr codegetGet payment urlgetGet payment detailsget
Endpoint:https://api.aws.movepayment.eu
POST /api/ecommerce/payment
curl --request POST \
  --url https://api.aws.movepayment.eu/api/ecommerce/payment \
  --data '
{
  "orderId": "order-id-123",
  "amount": 100,
  "moveId": "xyz@movepayment.eu",
  "languageCode": "de",
  "successUrl": "https://example.com/success-url",
  "cancelUrl": "https://example.com/cancel-url"
}
'
Show example in
Request Body Example
{
  "orderId": "order-id-123",
  "amount": 100,
  "moveId": "xyz@movepayment.eu",
  "languageCode": "de",
  "successUrl": "https://example.com/success-url",
  "cancelUrl": "https://example.com/cancel-url"
}
Example Responses
{
  "expires_at": "2022-01-01T00:00:00Z",
  "redirect_url": "https://example.com/redirect",
  "token": "token"
}
Create payment token
GET /api/ecommerce/payment/{token}/qr-code
curl --request GET \
  --url https://api.aws.movepayment.eu/api/ecommerce/payment/:token/qr-code
Show example in
Example Responses
Empty Response
GET /api/ecommerce/payment/{token}/pay-url
curl --request GET \
  --url https://api.aws.movepayment.eu/api/ecommerce/payment/:token/pay-url
Show example in
Example Responses
{
  "expires_at": "2022-01-01T00:00:00Z",
  "redirect_url": "https://example.com/redirect",
  "token": "token"
}
GET /api/ecommerce/payment/{token}
curl --request GET \
  --url https://api.aws.movepayment.eu/api/ecommerce/payment/:token
Show example in
Example Responses
{
  "orderId": "order-id-123",
  "amount": 100,
  "moveId": "xyz@movepayment.eu",
  "languageCode": "de",
  "data": {
    "move_id": "move-id-123",
    "amount": 100,
    "type": "BUSINESS",
    "avatar": "https://example.com/avatar.jpg",
    "name": "John Doe",
    "userExternalCode": null,
    "paymentId": "payment-id-123",
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel"
  }
}