• Documentation
  • API Reference
Overview

#Movepay Ecommerce API

The Movepay API ecommerce endpoints

Payment

#Initiate a new payment

This endpoint facilitates the creation of a new payment. It requires an API key for authentication and expects a payload with the payment details. The response contains a redirect_url to guide the user to the payment page, along with a payment token for subsequent operations.

#Headers

  • X-Api-Keyrequiredstring

    API key for authentication

#Request Body

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

    Name of the payer

#Responses

    • expires_atstring
    • redirect_urlstring
    • tokenstring
    • transaction_idstring

#Retrieve payment QR code

This endpoint generates a QR code for a given payment token. The response is a PNG image, which can be displayed directly or downloaded. This endpoint is useful for embedding the QR code in user interfaces.

#path Parameters

  • tokenrequiredstring

#Responses

    No response specified

#Retrieve payment URL

This endpoint generates a payment URL for a given token. The "redirect_url" in the response can be used to navigate the user directly to the payment page.

#path Parameters

  • tokenrequiredstring

#query Parameters

  • returnUrlrequiredstring

#Responses

    • expires_atstring
    • redirect_urlstring
    • tokenstring
    • transaction_idstring

#Retrieve payment details

This endpoint fetches the details of a payment using its token. It returns comprehensive information about the payment.

#path Parameters

  • tokenrequiredstring

#Responses

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

      Data about the payment

Webhook

#Register webhook endpoint

Registers a webhook URL for the specified business move id. Requires a valid X-Api-Key header.

#Headers

  • X-Api-Keyrequiredstring

    API key associated with the merchant

#Request Body

  • moveIdstring

    Business move id the webhook should belong to

  • urlstring

    Webhook endpoint URL

#Responses

    • idstring
    • urlstring
    • secretKeystring
Overview
Payment
    Initiate a new paymentpostRetrieve payment QR codegetRetrieve payment URLgetRetrieve payment detailsget
Webhook
    Register webhook endpointpost
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",
  "payerName": "Mario Rossi"
}
'
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",
  "payerName": "Mario Rossi"
}
Example Responses
{
  "expires_at": "2022-01-01T00:00:00Z",
  "redirect_url": "https://example.com/redirect",
  "token": "token",
  "transaction_id": "b3b8f8e2-9c2e-4c1a-8e2d-3f7b8e2c9c2e"
}
Payment token successfully created
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",
  "transaction_id": "b3b8f8e2-9c2e-4c1a-8e2d-3f7b8e2c9c2e"
}
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"
  }
}
POST /api/ecommerce/webhook
curl --request POST \
  --url https://api.aws.movepayment.eu/api/ecommerce/webhook \
  --data '
{
  "moveId": "abc123@movepayment.eu"
}
'
Show example in
Request Body Example
{
  "moveId": "abc123@movepayment.eu"
}
Example Responses
{}
Webhook created successfully