Checkout process
Test environment
- Test mode
- Test data
API Requests
Checkout creation
SDK Javascript
SDK iOS
SDK Android
Order confirmation
Capture of the order
Widget Integration
Order API
Campaigns API
POS Integration

Order API

Creation

Capture

A capture must be made when the product or products are sent with the import of the total price of the sale. The amount of the capture must be the total amount of the order less total amount of the canceled items.

{
    "amount": 10050,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 0
}

Parameter	Type	Required	Description
amount	decimal	yes	Capture amount
id	string	yes	Your capture `ID`
created	string	yes	Date of the capture
refunds	object	no	Refunds on capture done
refunded_amount	decimal	yes	Refunded capture amount
remaining_amount	decimal	yes	Remaining capture amount (It will always be 0)

01. Capture detail

GET /orders/:orderId/captures HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId/captures" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.get_capture_refund(':orderId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders/{$orderId}/captures");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get($"/orders/{orderId}/captures");

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "remaining_capture_amount": 60020,
    "results": [
        {
            "amount": 10050,
            "id": "cf04aa87a6364f14b164e48a84e99936",
            "created": "2019-06-21T16:51:19.494155+02:00",
            "refunds": [],
            "refunded_amount": 0,
            "remaining_amount": 10050
        }
    ]
}

Parameter	Type	Description
remaining_capture_amount	decimal	Remaining order amount without capture (It will always be 0)
results	object	Captures of order

02. Request capture

POST /orders/:orderId/captures HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

{
  "amount": 10050
}

$ curl "https://api.aplazame.com/orders/:orderId/captures" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST \
    -d "amount=10050"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.capture_refund(':orderId', 10050)

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/captures", ["amount" => Aplazame\Serializer\Decimal::fromFloat(100.50)->value]);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/captures", new {amount = Aplazame.Serializer.DecimalType.FromDouble(100.50)});

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
amount	decimal	yes	Amount to capture

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "remaining_capture_amount": 49970,
    "amount": 10050,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 10050
}

Parameter	Type	Description
remaining_capture_amount	decimal	Remaining order amount without capture (It will always be 0)
amount	decimal	Capture amount
id	string	Your capture `ID`
created	string	Date of the capture
refunds	object	Refunds on capture done
refunded_amount	decimal	Refunded capture amount
remaining_amount	decimal	Remaining capture amount (It will always be 0)

Details

GET /orders/:orderId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.get_order(':orderId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders/{$orderId}");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get($"/orders/{orderId}");

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
  "id": ":orderId",
  "...": "..."
}

Edit

PUT /orders/:orderId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Content-Type: application/json

{
  "order": {
    "shipping": {
      "first_name": "Django",
      "last_name": "Reinhard",
      "phone": "616123456",
      "alt_phone": "+34917909930",
      "street": "Plaza del Angel nº10",
      "address_addition": "Cerca de la plaza Santa Ana",
      "city": "Madrid",
      "state": "Madrid",
      "country": "ES",
      "postcode": "28012",
      "price": 500,
      "tax_rate": 2100,
      "name": "Planet Express",
      "discount": 100
    },
    "articles": [
      {
        "id": "59825349042875546873",
        "name": "N°5 eau premiere spray",
        "description": "A decidedly lighter, fresher...",
        "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity": 1,
        "price": 29000,
        "tax_rate": 2100
      }
    ],
    "discount": 300,
    "currency": "EUR",
    "total_amount": 31080
  }
}

$ curl "https://api.aplazame.com/orders/:orderId" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X PUT \
    --data-binary '{
      "order": {
        "shipping": {
          "first_name": "Django",
          "last_name": "Reinhard",
          "phone": "616123456",
          "alt_phone": "+34917909930",
          "street": "Plaza del Angel nº10",
          "address_addition": "Cerca de la plaza Santa Ana",
          "city": "Madrid",
          "state": "Madrid",
          "country": "ES",
          "postcode": "28012",
          "price": 500,
          "tax_rate": 2100,
          "name": "Planet Express",
          "discount": 100
        },
        "articles": [
          {
            "id": "59825349042875546873",
            "name": "N°5 eau premiere spray",
            "description": "A decidedly lighter, fresher...",
            "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
            "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
            "quantity": 1,
            "price": 29000,
            "tax_rate": 2100
          }
        ],
        "discount": 300,
        "currency": "EUR",
        "total_amount": 31080
      }
    }'

import aplazame_sdk

payload = {
  "order": {
    "shipping": {
      "first_name": "Django",
      "last_name": "Reinhard",
      "phone": "616123456",
      "alt_phone": "+34917909930",
      "street": "Plaza del Angel nº10",
      "address_addition": "Cerca de la plaza Santa Ana",
      "city": "Madrid",
      "state": "Madrid",
      "country": "ES",
      "postcode": "28012",
      "price": 500,
      "tax_rate": 2100,
      "name": "Planet Express",
      "discount": 100
    },
    "articles": [
      {
        "id": "59825349042875546873",
        "name": "N°5 eau premiere spray",
        "description": "A decidedly lighter, fresher...",
        "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity": 1,
        "price": 29000,
        "tax_rate": 2100
      }
    ],
    "discount": 300,
    "currency": "EUR",
    "total_amount": 31080
  }
}

client = aplazame_sdk.Client('api_private_key')

response = client.update(':orderId', payload)

<?php

use Aplazame\Api\Client as AplazameClient;

$payload = [
  "order" => [
    "shipping" => [
      "first_name" => "Django",
      "last_name" => "Reinhard",
      "phone" => "616123456",
      "alt_phone" => "+34917909930",
      "street" => "Plaza del Angel nº10",
      "address_addition" => "Cerca de la plaza Santa Ana",
      "city" => "Madrid",
      "state" => "Madrid",
      "country" => "ES",
      "postcode" => "28012",
      "price" => Aplazame\Serializer\Decimal::fromFloat(5)->value,
      "tax_rate" => Aplazame\Serializer\Decimal::fromFloat(21)->value,
      "name" => "Planet Express",
      "discount" => Aplazame\Serializer\Decimal::fromFloat(1)->value,
    ],
    "articles" => [
      [
        "id" => "59825349042875546873",
        "name" => "N°5 eau premiere spray",
        "description" => "A decidedly lighter, fresher...",
        "url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity" => 1,
        "price" => Aplazame\Serializer\Decimal::fromFloat(290)->value,
        "tax_rate" => Aplazame\Serializer\Decimal::fromFloat(21)->value,
      ],
    ],
    "discount" => Aplazame\Serializer\Decimal::fromFloat(3)->value,
    "currency" => "EUR",
    "total_amount" => Aplazame\Serializer\Decimal::fromFloat(310.80)->value,
  ],
];

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->put("/orders/{$orderId}", $payload);

using Aplazame.Api;

use Aplazame\Api\Client as AplazameClient;

dynamic payload = new {
  order = new {
    shipping = new {
      first_name = "Django",
      last_name = "Reinhard",
      phone = "616123456",
      alt_phone = "+34917909930",
      street = "Plaza del Angel nº10",
      address_addition = "Cerca de la plaza Santa Ana",
      city = "Madrid",
      state = "Madrid",
      country = "ES",
      postcode = "28012",
      price = Aplazame.Serializer.DecimalType.FromDecimal(5),
      tax_rate = Aplazame.Serializer.DecimalType.FromDecimal(21),
      name = "Planet Express",
      discount = Aplazame.Serializer.DecimalType.FromDecimal(1),
    },
    articles = new dynamic[] {
      new {
        id = "59825349042875546873",
        name = "N°5 eau premiere spray",
        description = "A decidedly lighter, fresher...",
        url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        image_url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        quantity = 1,
        price = Aplazame.Serializer.DecimalType.FromDecimal(290),
        tax_rate = Aplazame.Serializer.DecimalType.FromDecimal(21),
      },
    },
    discount = Aplazame.Serializer.DecimalType.FromDecimal(3),
    currency = "EUR",
    total_amount = Aplazame.Serializer.DecimalType.FromDecimal(310.80),
  },
};

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Put($"/orders/{orderId}", payload);

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
order	object	yes	Order to update

HTTP/1.1 204 No Content
X-Aplazame-Media-Type: aplazame.v1

Partial edit

PATCH /orders/:orderId HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Content-Type: application/json

{
  "order": {
    "articles": [
      {
        "id": "59825349042875546873",
        "name": "N°5 eau premiere spray",
        "description": "A decidedly lighter, fresher...",
        "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity": 1,
        "price": 29000,
        "tax_rate": 2100
      }
    ],
    "discount": 300
  }
}

$ curl "https://api.aplazame.com/orders/:orderId" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X PATCH \
    --data-binary '{
      "order": {
        "articles": [
          {
            "id": "59825349042875546873",
            "name": "N°5 eau premiere spray",
            "description": "A decidedly lighter, fresher...",
            "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
            "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
            "quantity": 1,
            "price": 29000,
            "tax_rate": 2100
          }
        ],
        "discount": 300
      }
    }'

import aplazame_sdk

payload = {
  "order": {
    "articles": [
      {
        "id": "59825349042875546873",
        "name": "N°5 eau premiere spray",
        "description": "A decidedly lighter, fresher...",
        "url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url": "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity": 1,
        "price": 29000,
        "tax_rate": 2100
      }
    ],
    "discount": 300
  }
}

client = aplazame_sdk.Client('api_private_key')

response = client.update(':orderId', payload, partial=True)

<?php

use Aplazame\Api\Client as AplazameClient;

$payload = [
  "order" => [
    "articles" => [
      [
        "id" => "59825349042875546873",
        "name" => "N°5 eau premiere spray",
        "description" => "A decidedly lighter, fresher...",
        "url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        "image_url" => "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        "quantity" => 1,
        "price" => Aplazame\Serializer\Decimal::fromFloat(290)->value,
        "tax_rate" => Aplazame\Serializer\Decimal::fromFloat(21)->value,
      ],
    ],
    "discount" => Aplazame\Serializer\Decimal::fromFloat(3)->value,
  ],
];

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->patch("/orders/{$orderId}", $payload);

using Aplazame.Api;

use Aplazame\Api\Client as AplazameClient;

dynamic payload = new {
  order = new {
    articles = new dynamic[] {
      new {
        id = "59825349042875546873",
        name = "N°5 eau premiere spray",
        description = "A decidedly lighter, fresher...",
        url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083",
        image_url = "http://www.chanel.com/fragrance-beauty/Fragrance-N05-88145/sku/138083/product_01.jpg",
        quantity = 1,
        price = Aplazame.Serializer.DecimalType.FromDecimal(290),
        tax_rate = Aplazame.Serializer.DecimalType.FromDecimal(21),
      },
    },
    discount = Aplazame.Serializer.DecimalType.FromDecimal(3),
  },
};

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Patch($"/orders/{orderId}", payload);

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
order	object	Partial	Order to update

HTTP/1.1 204 No Content
X-Aplazame-Media-Type: aplazame.v1

List

GET /orders HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.orders()

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get("/orders");

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
  "cursor": {
    "after": 3,
    "before": 1
  },
  "paging": {
    "count": 314,
    "next": "https://api.aplazame.com/orders?page=3",
    "previous": "https://api.aplazame.com/orders?page=1"
  },
  "results": [
  ]
}

Parameter	Type	Description
cursor	object	Pagination cursor object
paging	object	Pagination status
results	collection	List of stores

Void

An order accepts several partial voids only if the sum of the amount does not exceed the total of the original order. If the total amount is void, the order will be canceled.

01. Check voids

GET /orders/:orderId/void HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId/void" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.void_check(':orderId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders/{$orderId}/void");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get($"/orders/{orderId}/void");

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
   "remaining_amount":60020,
   "results":[
      {
         "amount":1000,
         "id":"7b596c68e9044737a838d54b9e7971a3",
         "created":"2020-10-09T13:56:09.043797+02:00"
      },
      {
         "amount":500,
         "id":"e07b9d47a72c4c7d8c9fc0c0bb2ba9b9",
         "created":"2020-10-09T13:59:05.697921+02:00"
      }
   ]
}

Parameter	Type	Description
remaining_amount	decimal	Remaining capture amount
results	collection	List of voids

02. Request void

POST /orders/:orderId/void HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

{
  "amount": 10050
}

$ curl "https://api.aplazame.com/orders/:orderId/void" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST \
    -d "amount=10050"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.void(':orderId', 10050)

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/void", ["amount" => Aplazame\Serializer\Decimal::fromFloat(100.50)->value]);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/void", new {amount = Aplazame.Serializer.DecimalType.FromDouble(100.50)});

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
amount	decimal	yes	Amount to void

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
   "remaining_amount":60020,
   "results":[
      {
         "amount":1000,
         "id":"7b596c68e9044737a838d54b9e7971a3",
         "created":"2020-10-09T13:56:09.043797+02:00"
      },
      {
         "amount":500,
         "id":"e07b9d47a72c4c7d8c9fc0c0bb2ba9b9",
         "created":"2020-10-09T13:59:05.697921+02:00"
      }
   ]
}

Parameter	Type	Description
remaining_amount	decimal	Remaining capture amount
results	collection	List of voids

Refund

To make a refund, It will be done in one way or another depending on the type of operation

Check remaining amount

Refund online financing

An order accepts several partial returns only if the sum of the amount does not exceed the total of the original order. If the total amount is refunded, the order will be canceled.

Each partial refund operation affects the amount of future loan instalments. The amount of the refund will be reflected in the store’s commercial transactions and may include a refund of the amount to the buyer.

01. Check remaining amount

GET /orders/:orderId/refund HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId/refund" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.refund_check(':orderId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders/{$orderId}/refund");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get($"/orders/{orderId}/refund");

Parameter	Type	Required	Description
:orderId	string	yes	Capture ID.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
  "remaining_amount": 70070
}

02. Request refund

POST /orders/:orderId/refund HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

{
  "amount": 10050
}

$ curl "https://api.aplazame.com/orders/:orderId/refund" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST \
    -d "amount=10050"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.refund(':orderId', 10050)

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/refund", ["amount" => Aplazame\Serializer\Decimal::fromFloat(100.50)->value]);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/refund", new {amount = Aplazame.Serializer.DecimalType.FromDouble(100.50)});

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
amount	decimal	yes	Amount to refund

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
  "remaining_amount": 60020
}

Parameter	Type	Description
remaining_amount	decimal	Remaining capture amount

Check remaining amount

The refund is made at the capture level within an order. Being possible the refund of several captures.

A capture of an order accepts several partial refunds only if the sum of the amount does not exceed the total of the original capture.

{
    "id": "db654bf752a84b7eaf6fcb7ab5801f60",
    "amount": 10050,
    "pending_amount": 0,
    "accrual_date": "2019-06-21",
    "credit_to_customer": 0,
    "completed": false,
    "completed_but_defaults": false,
    "created": "2019-06-21T16:52:07.733892+02:00"
}

Parameter	Type	Required	Description
id	string	yes	Your refund `ID`
amount	decimal	yes	Refund amount
pending_amount	decimal	yes	Remaining capture amount
accrual_date	string	yes	Effective date of refund
credit_to_customer	decimal	yes	Refund amount to customer
completed	boolean	yes	Order completed
completed_but_defaults	boolean	yes	Order completed but with defaults
created	string	yes	Date of refund

01. Check remaining amount

GET /orders/:orderId/captures/:captureId/refunds HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId/captures/:captureId/refunds" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.get_capture_refund(':orderId', ':captureId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->get("/orders/{$orderId}/captures/{$captureId}/refunds");

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Get($"/orders/{orderId}/captures/{captureId}/refunds");

Parameter	Type	Required	Description
:orderId	string	yes	Capture ID.
:captureId	string	yes	Capture ID.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "amount": 70070,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [],
    "refunded_amount": 0,
    "remaining_amount": 70070
}

Parameter	Type	Description
amount	decimal	Capture amount
id	string	Your capture `ID`
created	string	Date of the capture
refunds	object	Refunds on capture done
refunded_amount	decimal	Remaining capture amount
remaining_amount	decimal	Remaining capture amount

02. Request refund

POST /orders/:orderId/captures/:captureId/refunds HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

{
  "amount": 10050
}

$ curl "https://api.aplazame.com/orders/:orderId/captures/:captureId/refunds" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST \
    -d "amount=10050"

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.capture_refund(':orderId', ':captureId', 10050)

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/captures/{$captureId}/refunds", ["amount" => Aplazame\Serializer\Decimal::fromFloat(100.50)->value]);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/captures/{captureId}/refunds", new {amount = Aplazame.Serializer.DecimalType.FromDouble(100.50)});

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.
:captureId	string	yes	Capture ID.
amount	decimal	yes	Amount to refund

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Aplazame-Media-Type: aplazame.v1

{
    "amount": 70070,
    "id": "cf04aa87a6364f14b164e48a84e99936",
    "created": "2019-06-21T16:51:19.494155+02:00",
    "refunds": [
        {
            "id": "db654bf752a84b7eaf6fcb7ab5801f60",
            "amount": 10050,
            "pending_amount": 60020,
            "accrual_date": "2019-06-21",
            "credit_to_customer": 0,
            "completed": false,
            "completed_but_defaults": false,
            "created": "2019-06-21T16:52:07.733892+02:00"
        }
    ],
    "refunded_amount": 10050,
    "remaining_amount": 60020
}

Parameter	Type	Description
amount	decimal	Capture amount
id	string	Your capture `ID`
created	string	Date of the capture
refunds	object	Refunds on capture done
refunded_amount	decimal	Remaining capture amount
remaining_amount	decimal	Remaining capture amount

Cancellation

Once the order has been cancelled, it cannot be modified.

The cancellation amount will show up in the store’s commercial transactions and a full refund will be given for the amounts previously paid by the buyer.

POST /orders/:orderId/cancel HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com

$ curl "https://api.aplazame.com/orders/:orderId/cancel" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST

import aplazame_sdk

client = aplazame_sdk.Client('api_private_key')

response = client.cancel(':orderId')

<?php

use Aplazame\Api\Client as AplazameClient;

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/cancel", []);

using Aplazame.Api;

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/cancel", new {});

Parameter	Type	Required	Description
:orderId	string	yes	Order ID.

HTTP/1.1 204 No Content
X-Aplazame-Media-Type: aplazame.v1

History

It is recommended that this be sent asynchronously so as not to delay the loading of the template.

POST /orders/:orderId/history HTTP/1.1
Accept: application/vnd.aplazame.v1+json
Authorization: Bearer api_private_key
Host: api.aplazame.com
Content-Type: application/json

[{
  "id": "18857527248912279381",
  "amount": 12080,
  "due": "",
  "status": "cancelled",
  "type": "paypal",
  "order_date": "2014-03-21T13:56:45+0000",
  "currency": "EUR",
  "billing": null,
  "shipping": {
    "first_name": "Django",
    "last_name": "Reinhard",
    "phone": "616123456",
    "alt_phone": "+34917909930",
    "street": "Plaza del Angel nº10",
    "address_addition": "Cerca de la plaza Santa Ana",
    "city": "Madrid",
    "state": "Madrid",
    "country": "ES",
    "postcode": "28012",
    "price": 500,
    "tax_rate": 2100,
    "name": "Planet Express",
    "discount": 100
  }
}]

$ curl "https://api.aplazame.com/orders/:orderId/history" \
    -H "Accept: application/vnd.aplazame.v1+json" \
    -H "Authorization: Bearer api_private_key" \
    -X POST \
    --data-binary '[
      {
        "id": "18857527248912279381",
        "amount": 12080,
        "due": "",
        "status": "cancelled",
        "type": "paypal",
        "order_date": "2014-03-21T13:56:45+0000",
        "currency": "EUR",
        "shipping": {
          "first_name": "Django",
          "last_name": "Reinhard",
          "phone": "616123456",
          "alt_phone": "+34917909930",
          "street": "Plaza del Angel nº10",
          "address_addition": "Cerca de la plaza Santa Ana",
          "city": "Madrid",
          "state": "Madrid",
          "country": "ES",
          "postcode": "28012",
          "price": 500,
          "tax_rate": 2100,
          "name": "Planet Express",
          "discount": 100
        }
      }
    ]'

import aplazame_sdk

payload = [
  {
    "id": "18857527248912279381",
    "amount": 12080,
    "due": "",
    "status": "cancelled",
    "type": "paypal",
    "order_date": "2014-03-21T13:56:45+0000",
    "currency": "EUR",
    "billing": None,
    "shipping": {
      "first_name": "Django",
      "last_name": "Reinhard",
      "phone": "616123456",
      "alt_phone": "+34917909930",
      "street": "Plaza del Angel nº10",
      "address_addition": "Cerca de la plaza Santa Ana",
      "city": "Madrid",
      "state": "Madrid",
      "country": "ES",
      "postcode": "28012",
      "price": 500,
      "tax_rate": 2100,
      "name": "Planet Express",
      "discount": 100
    }
  }
]

client = aplazame_sdk.Client('api_private_key')

response = client.history(':orderId', payload)

<?php

use Aplazame\Api\Client as AplazameClient;

$payload = [
  [
    "id" => "18857527248912279381",
    "amount" => Aplazame\Serializer\Decimal::fromFloat(120.80)->value,
    "due" => "",
    "status" => "cancelled",
    "type" => "paypal",
    "order_date" => Aplazame\Serializer\Date::fromDateTime(new DateTime("2014-03-21 13:56:45"))->value,
    "currency" => "EUR",
    "billing" => null,
    "shipping" => [
      "first_name" => "Django",
      "last_name" => "Reinhard",
      "phone" => "616123456",
      "alt_phone" => "+34917909930",
      "street" => "Plaza del Angel nº10",
      "address_addition" => "Cerca de la plaza Santa Ana",
      "city" => "Madrid",
      "state" => "Madrid",
      "country" => "ES",
      "postcode" => "28012",
      "price" => Aplazame\Serializer\Decimal::fromFloat(5)->value,
      "tax_rate" => Aplazame\Serializer\Decimal::fromFloat(21)->value,
      "name" => "Planet Express",
      "discount" => Aplazame\Serializer\Decimal::fromFloat(1)->value,
    ],
  ],
];

$aplazameClient = new AplazameClient("https://api.aplazame.com", AplazameClient::ENVIRONMENT_PRODUCTION, "api_private_key");

$result = $aplazameClient->post("/orders/{$orderId}/history", $payload);

using Aplazame.Api;

dynamic payload = [
  [
    "id" => "18857527248912279381",
    "amount" => Aplazame.Serializer.DecimalType.FromDouble(120.80),
    "due" => "",
    "status" => "cancelled",
    "type" => "paypal",
    "order_date" => Aplazame.Serializer.DateType.FromDateTime(DateTime.Parse("2014-03-21 13:56:45")),
    "currency" => "EUR",
    "billing" => null,
    "shipping" => [
      "first_name" => "Django",
      "last_name" => "Reinhard",
      "phone" => "616123456",
      "alt_phone" => "+34917909930",
      "street" => "Plaza del Angel nº10",
      "address_addition" => "Cerca de la plaza Santa Ana",
      "city" => "Madrid",
      "state" => "Madrid",
      "country" => "ES",
      "postcode" => "28012",
      "price" => Aplazame.Serializer.DecimalType.FromDouble(5),
      "tax_rate" => Aplazame.Serializer.DecimalType.FromDouble(21),
      "name" => "Planet Express",
      "discount" => Aplazame.Serializer.DecimalType.FromDouble(1),
    ],
  ],
];

Client client = new Client("https://api.aplazame.com", Client.EnvironmentProduction, "api_private_key");

dynamic result = client.Post($"/orders/{orderId}/history", payload);

Parameter	Type	Required	Description
:orderId	string	yes	Your order `ID`
id	string	yes	Your order `ID`
amount	decimal	yes	Order amount
due	decimal	no	Total order amount due
status	string	yes	Order status; the choices are `pending`, `cancelled`, `processing` and `complete`
type	string	yes	Order type
order_date	string	yes	Date of the order
currency	ISO 4217	yes	Currency code of the order
billing	object	no	Billing address
shipping	object	no	Shipping info

HTTP/1.1 204 No Content
X-Aplazame-Media-Type: aplazame.v1

Tiendas por categoría

Aumenta tus ventas

Elige tu sector:

Recursos para comercios

Productos

Dónde utilizar Aplazame

Order API

Creation

Capture

01. Capture detail

02. Request capture

Details

Edit

Partial edit

List

Void

01. Check voids

02. Request void

Refund

Check remaining amount

01. Check remaining amount

02. Request refund

Check remaining amount

01. Check remaining amount

02. Request refund

Cancellation

History