Paths
/{original-tx-id}/capture
text/plain
text/plain
200 OK
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Definitions
Object that defines the back office operation request fields.
{
"properties": {
"merchant": {
"$ref": "#/definitions/MerchantInput",
"description": "Object that defines the Merchant. Check the Merchant definition."
},
"customer": {
"$ref": "#/definitions/Customer",
"description": "Object that defines a Customer. Check the Customer definition."
},
"transaction": {
"$ref": "#/definitions/TransactionInput",
"description": "Object that defines the information about the Transaction. Check the Transaction definition."
},
"saleContext": {
"description": "Object that defines the Sale Context. Check the SaleContext definition.",
"$ref": "#/definitions/SaleContext"
},
"retry": {
"description": "Object that defines the retry information. Check the Retry definition.",
"$ref": "#/definitions/Retry"
}
},
"additionalProperties": false
}
Parameter with the value and currency of the transaction
{
"properties": {
"value": {
"type": "number",
"format": "double",
"example": 20.45
},
"currency": {
"type": "string",
"description": "The currency of the transaction.",
"example": "EUR"
}
},
"additionalProperties": false
}
Object that defines the Original Transaction.
{
"properties": {
"id": {
"type": "string",
"description": "ID of the Transaction"
},
"datetime": {
"type": "string",
"description": "The datetime of the original transaction.",
"example": "2019-04-07T18:13:18.572+01:00"
}
},
"additionalProperties": false
}
Object that defines the back office operation response fields.
{
"properties": {
"merchant": {
"$ref": "#/definitions/MerchantOutput",
"description": "Object that defines the Merchant. Check the Merchant definition."
},
"returnStatus": {
"description": "Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself).",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "ID of the transaction"
},
"amount": {
"description": "Parameter with the value and currency of the transaction.",
"$ref": "#/definitions/Amount"
},
"transactionTimestamp": {
"type": "string",
"description": "Transaction timestamp",
"example": "2019-04-07T18:13:18.572+01:00"
},
"transactionRecipientId": {
"type": "string",
"description": "Original Transaction ID."
},
"execution": {
"description": "Description of an Execution, see the Execution definition.",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string"
}
},
"additionalProperties": false
}
{
"properties": {
"amount": {
"description": "Parameter with the value and currency of the transaction.",
"$ref": "#/definitions/Amount"
},
"description": {
"type": "string",
"description": "Transaction description"
},
"transactionTimestamp": {
"type": "string",
"description": "Timestamp of the transaction",
"example": "2019-04-07T18:13:18.572+01:00"
},
"originalTransaction": {
"description": "Original transaction of a Backoffice transaction.",
"$ref": "#/definitions/OriginalTransaction"
}
},
"additionalProperties": false
}
Object that defines the status of the processed transaction.
{
"properties": {
"statusCode": {
"type": "string",
"description": "Identifier code of the processed transaction status.",
"example": "000"
},
"statusMsg": {
"type": "string",
"description": "Message of the processed transaction status.",
"example": "Success"
},
"statusDescription": {
"type": "string",
"description": "Description of the processed transaction status."
}
},
"additionalProperties": false
}
Object that defines a customer.
{
"properties": {
"customerInfo": {
"description": "Object that defines the customer predefined information (name, age, etc). Check the CustomerInfo definition.",
"example": "",
"$ref": "#/definitions/CustomerInfo"
},
"extendedInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false
}
Object that defines the predefined customer information.
{
"properties": {
"customerName": {
"type": "string",
"description": "Name of the customer.",
"example": "John"
},
"shippingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
},
"billingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
},
"billingAddressSameAsShippingAddress": {
"type": "boolean",
"description": "Flag that identifies that the billing address is the same as the shipping address",
"example": "true"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
{
"properties": {
"street1": {
"type": "string",
"example": "First street"
},
"street2": {
"type": "string"
},
"city": {
"type": "string",
"example": "Lisbon"
},
"postcode": {
"type": "string",
"example": "1700-123"
},
"country": {
"type": "string",
"example": "PT"
}
},
"additionalProperties": true
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Terminal ID"
},
"channel": {
"type": "string",
"description": "Channel used in the transaction"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique identifier of the transaction in the merchant perspective"
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Terminal ID"
},
"channel": {
"type": "string",
"description": "Channel used in the transaction"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique identifier of the transaction in the merchant perspective"
},
"merchantTransactionTimestamp": {
"type": "string",
"description": "Merchant transaction timestamp",
"example": "2019-04-07T18:13:18.572+01:00"
}
},
"additionalProperties": false
}
Object that defines the back office operation sale context.
{
"properties": {
"splitPayment": {
"description": "Object that defines the Split Payment. Check the SplitPayment definition.",
"$ref": "#/definitions/SplitPayment"
}
},
"additionalProperties": false
}
Object that defines the split payment options.
{
"properties": {
"split": {
"type": "boolean",
"description": "Boolean that defines if it is to split or not."
},
"paymentNumber": {
"type": "integer",
"format": "int32",
"description": "Integer that defines the Payment Number."
},
"maxPayments": {
"type": "integer",
"format": "int32",
"description": "Integer that defines the maximum number of payments."
}
},
"additionalProperties": false
}
Retry counter for repeated invocations
{
"properties": {
"counter": {
"type": "integer",
"example": "1",
"description": "Counter for the number of retries for repeating invocations.",
"format": "int32"
}
},
"additionalProperties": false
}
{
"properties": {
"startTime": {
"type": "string",
"description": "Time of the acceptance of the request by the API.",
"format": "date-time",
"example": "2020-07-15T11:10:49.131Z"
},
"endTime": {
"type": "string",
"description": "Time of the response to the request by the API.",
"format": "date-time",
"example": "2020-07-15T11:10:49.131Z"
}
},
"additionalProperties": false
}