Voucher reservations

POST 
/v3/vouchers/reservations

Voucher reservations

Request

Path Parameters

sellerId stringrequired

Possible values: >= 15 characters and <= 15 characters, Value must match regular expression ^([a-zA-Z0-9]{3}(-[a-zA-Z0-9]{3}){3})$

Seller ID obtained during seller boarding

Header Parameters

Api-Key stringrequired

Unique key used to authenticate API requests.

Signature stringrequired

The Signature header is used to ensure the request’s body integrity and to confirm that its content has not changed.

Accept stringrequired

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. Can be set to */*.

Idempotency-Key stringrequired

Possible values: <= 45 characters

A unique identifier used to ensure idempotent behavior. If the business application request fails or you receive a timeout you can retry the request with the same Idempotency-Key to guarantee that only one business object is created.

Content-Type stringrequired

The Content-Type entity header is used to indicate the media type of the resource.

application/json

Body

required

Request body for voucher reservation request

voucherCode stringrequired

Voucher code

amount int64required

Amount of the order. A positive integer in the smallest currency unit.

Possible values: <= 10 characters

transfers

object[]

required

Sellers transfer list

Array [

sellerId stringrequired

Seller ID

Possible values: <= 15 characters

grossAmount int64required

Transfer gross amount in the smallest currency unit

Possible values: <= 10 characters, >= 1 and <= 100000000

]

Responses

200

Success

application/json

Schema

Schema

voucherReservationId stringrequired

Voucher reservation ID to create payment with voucher code.

Possible values: <= 15 characters

payerAmount int64required

Amount to be paid by the payer. A positive integer in the smallest currency unit.

Possible values: <= 10 characters

voucherAmount int64required

Amount to be charged from the voucher. A positive integer in the smallest currency unit.

Possible values: <= 10 characters

transfers

object

required

sellerId stringrequired

Seller ID

Possible values: <= 15 characters

payerGrossAmount int64required

Amount to be paid by the payer in the smallest currency unit

Possible values: <= 10 characters, >= 1 and <= 100000000

voucherGrossAmount int64required

Amount to be charged from the voucher card balance in the smallest currency unit

Possible values: <= 10 characters, >= 1 and <= 100000000

Example (from schema)

{
  "voucherReservationId": "FW3-4R3-AP1-VSM",
  "payerAmount": 5671,
  "voucherAmount": 40000,
  "transfers": [
    {
      "sellerId": "MBV-A4F-H2W-ARS",
      "payerGrossAmount": 5671,
      "voucherGrossAmount": 40000
    }
  ]
}

400

Bad request

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [FORBIDDEN, RATE_LIMIT_REACHED, SYSTEM_TEMPORARILY_UNAVAILABLE, VALIDATION_ERROR, VERIFICATION_FAILED, IDEMPOTENCY_KEY_MISSING, SIGNATURE_MISSING, PAYMENT_AMOUNT_TOO_LARGE, PAYMENT_AMOUNT_TOO_SMALL, ORDER_AMOUNT_TOO_SMALL_FOR_VOUCHER, INVALID_SUM_OF_TRANSFERS_GROSS_AMOUNT, VOUCHER_CARD_EXPIRED, VOUCHER_CARD_NO_FUNDS]

message string

Error description

value string

Optional value related to given error type. Applies only to [PAYMENT_AMOUNT_TOO_SMALL, ORDER_AMOUNT_TOO_SMALL_FOR_VOUCHER, PAYMENT_AMOUNT_TOO_LARGE]

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "FORBIDDEN",
      "message": "string",
      "value": "string"
    }
  ]
}

Example

{
  "statusCode": 400,
  "errors": [
    {
      "errorType": "SIGNATURE_MISSING",
      "message": "Missing field XXX"
    },
    {
      "errorType": "IDEMPOTENCY_KEY_MISSING",
      "message": "Missing field XXX"
    }
  ]
}

401

Unauthorized, invalid or missing credentials

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

oneOf

UnauthorizedErrorDetails

Error details

errorType stringrequired

Error type

Possible values: [UNAUTHORIZED]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {}
  ]
}

Example

{
  "statusCode": 401,
  "errors": [
    {
      "errorType": "UNAUTHORIZED",
      "message": "Unauthorized, invalid or missing credentials"
    }
  ]
}

404

Not found

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [NOT_FOUND]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 404,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "Resource not found"
    }
  ]
}

500

Internal server error

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [INTERNAL_SERVER_ERROR]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 500,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "Internal server error"
    }
  ]
}

503

Service is temporarily unavailable

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [SYSTEM_TEMPORARILY_UNAVAILABLE]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 503,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "Service is temporarily unavailable"
    }
  ]
}

Loading...