Pre-authorization captured

This event occurs when a pre-authorization is captured.
Generated by: Capture pre-authorization

Type: object
Additional properties: false
Domain: authorization
Event: pre-authorization-capture
Version: 1

|
amount required

Description: Amount captured in the pre-authorization. This value may be different from the pre-authorization's original amount.
Type: number
Example:
20.1
100.0
50

authorization required

Title: Authorization object
Description: Reflects the authorization information.
Type: object
Additional properties: false

id required

Description: Authorization ID.
Type: integer
Example:
123
456
789

code

Description: Authorization code ID.
Type: string
Example:
143726
113526

descriptor

Description: Descriptor of the payment.
Type: string
Example:
P2P
P2P card on file
Cash-out
Cash-in
Cash-in card on file

operation_description required

Description: Description of the operation.
Type: string
Example:
CASH-IN
INTEREST FREE INSTALLMENTS
TRANSFER
WITHDRAWAL
PAYMENT

processing_code required

Description: Processing code used for the authorization.
Type: string
Example:
007700
009900
007200

account required

Type: object
Additional properties: false

id required

Description: Account ID.
Type: integer
Example:
123
456
789

card required

Title: Card object
Description: Reflects card information on operations that utilize cards.
Type: object
Additional properties: false

tid required

Description: Transaction ID provided by the acquirer layer.
Type: string
Example:
123456789
987654321

id required

Description: Card UUID
Type: string
Example:
b8bb8116-e7f4-46b2-b71b-bfb81ce9ce41
bbd3912a-eb71-4467-ad8f-2942ee4cc403

acquirer required

Description: Acquirer that processed the operation.
Type: string
Example:
REDE

custom

Title: Custom object
Description: Object that reflects custom cash-in/cash-out operation.
Type: object
Additional properties: false

id

Description: Custom ID.
Type: integer
Example:
123
456
789

type

Description: Type of custom information.
Type: string
Example:
TED/TEF
Cash-in via invoice

description

Description: Description of custom information.
Type: string
Example:
Invoce paid via internet banking

name

Description: Name of custom information.
Type: string
Example:
Invoice

external_id

Description: External ID.
Type: string
Example:
uuid

origin

Description: Origin used in migrations.
Type: string
Example:
STRIKER

accounting_date

Description: Accounting date used in the migrations processes.
Type: string
Format: date-time
Example:
2021-06-04T10:37:37.83Z

capture_id required

Description: Unique generated ID of the capture operation.
Type: integer
Example:
1374
2516

correlation_id required

Description: Unique hash to identify the correlation of operations.
Type: string
Example:
2b190358-d339-4a69-b313-944e189c0a85

event_date required

Description: Event timestamp in the UTC ISO-8601 format.
Type: string
Format: date-time
Example:
2021-06-04T10:37:37.83Z

nsu required

Description: Unique sequential number of the capture operation. This value may be different from the pre-authorization's original NSU.
Type: string
Example:
12345

tracking_id required

Description: Unique 36-character long ID that identifies the original pre-authorization that was captured.
Type: string
Example:
9cd6485a-5680-4df0-a1f1-507e21d3428c

skip_timeline required

Description: Indicates whether the capture should skip the generation of an event in the customer's timeline.
Type: boolean
Example:
true
false

installments

Title: Installments information
Description: Reflects installments information.
Type: object
Additional properties: false

number_of_installments

Description: Number of installments in a payment.
Type: integer
Example:
1
10

deferred_months

Description: Months that have been accepted in the negotiation.
Type: integer
Example:
null
1
12

location

Title: Location object
Description: Object that reflects latitude/longitude used in the authorization.
Type: object
Additional properties: false

latitude

Description: Latitude where the authorization occurred.
Type: number
Example:
24.12
-23.1

longitude

Description: Longitude where the authorization occurred.
Type: number
Example:
24.12
-23.1

metadata

Title: Any custom information that may be relevant to the caller. No business rule validation is performed on it. This custom information is related to the original pre-authorization, and not to the capture itself.
Type: object or null
Additional properties: true
Example:

{
    "metadata": {
        "customer-data": {
            "any": "fields"
        }
    }
}
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Pre-authorization captured",
    "description": "This event occurs when a pre-authorization is captured. <br> Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-payments-v1-payments-capture' target='_blank'>Capture pre-authorization</a>",
    "additionalProperties": false,
    "required": [
        "capture_id",
        "tracking_id",
        "correlation_id",
        "event_date",
        "amount",
        "authorization",
        "skip_timeline",
        "nsu"
    ],
    "properties": {
        "amount": {
            "type": "number",
            "description": "Amount captured in the pre-authorization. This value may be different from the pre-authorization's original amount.",
            "examples": [
                20.1,
                100.0,
                50
            ]
        },
        "authorization": {
            "$ref": "#/definitions/authorization"
        },
        "capture_id": {
            "type": "integer",
            "description": "Unique generated ID of the capture operation.",
            "examples": [
                1374,
                2516
            ]
        },
        "correlation_id": {
            "type": "string",
            "description": "Unique hash to identify the correlation of operations.",
            "examples": [
                "2b190358-d339-4a69-b313-944e189c0a85"
            ]
        },
        "event_date": {
            "type": "string",
            "description": "Event timestamp in the UTC ISO-8601 format.",
            "format": "date-time",
            "examples": [
                "2021-06-04T10:37:37.83Z"
            ]
        },
        "nsu": {
            "type": "string",
            "description": "Unique sequential number of the capture operation. This value may be different from the pre-authorization's original NSU.",
            "examples": [
                "12345"
            ]
        },
        "tracking_id": {
            "type": "string",
            "description": "Unique 36-character long ID that identifies the original pre-authorization that was captured.",
            "examples": [
                "9cd6485a-5680-4df0-a1f1-507e21d3428c"
            ]
        },
        "skip_timeline": {
            "type": "boolean",
            "description": "Indicates whether the capture should skip the generation of an event in the customer's timeline.",
            "examples": [
                true,
                false
            ]
        },
        "installments": {
            "$ref": "#/definitions/installments"
        },
        "location": {
            "$ref": "#/definitions/location"
        },
        "metadata": {
            "type": [
                "object",
                "null"
            ],
            "title": "Any custom information that may be relevant to the caller. No business rule validation is performed on it. This custom information is related to the original pre-authorization, and not to the capture itself.",
            "examples": [
                {
                    "metadata": {
                        "customer-data": {
                            "any": "fields"
                        }
                    }
                }
            ],
            "additionalProperties": true
        }
    },
    "definitions": {
        "account": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "id"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "description": "Account ID.",
                    "examples": [
                        123,
                        456,
                        789
                    ]
                }
            }
        },
        "authorization": {
            "type": "object",
            "title": "Authorization object",
            "description": "Reflects the authorization information.",
            "additionalProperties": false,
            "required": [
                "id",
                "operation_description",
                "processing_code",
                "account",
                "card"
            ],
            "properties": {
                "id": {
                    "type": "integer",
                    "description": "Authorization ID.",
                    "examples": [
                        123,
                        456,
                        789
                    ]
                },
                "code": {
                    "type": "string",
                    "description": "Authorization code ID.",
                    "examples": [
                        "143726",
                        "113526"
                    ]
                },
                "descriptor": {
                    "type": "string",
                    "description": "Descriptor of the payment.",
                    "examples": [
                        "P2P",
                        "P2P card on file",
                        "Cash-out",
                        "Cash-in",
                        "Cash-in card on file"
                    ]
                },
                "operation_description": {
                    "type": "string",
                    "description": "Description of the operation.",
                    "examples": [
                        "CASH-IN",
                        "INTEREST FREE INSTALLMENTS",
                        "TRANSFER",
                        "WITHDRAWAL",
                        "PAYMENT"
                    ]
                },
                "processing_code": {
                    "type": "string",
                    "description": "Processing code used for the authorization.",
                    "examples": [
                        "007700",
                        "009900",
                        "007200"
                    ]
                },
                "account": {
                    "$ref": "#/definitions/account"
                },
                "card": {
                    "$ref": "#/definitions/card"
                },
                "custom": {
                    "$ref": "#/definitions/custom"
                }
            }
        },
        "location": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "latitude": {
                    "type": "number",
                    "description": "Latitude where the authorization occurred.",
                    "examples": [
                        24.12,
                        -23.1
                    ]
                },
                "longitude": {
                    "type": "number",
                    "description": "Longitude where the authorization occurred.",
                    "examples": [
                        24.12,
                        -23.1
                    ]
                }
            },
            "title": "Location object",
            "description": "Object that reflects latitude/longitude used in the authorization."
        },
        "custom": {
            "type": "object",
            "title": "Custom object",
            "description": "Object that reflects custom cash-in/cash-out operation.",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "integer",
                    "description": "Custom ID.",
                    "examples": [
                        123,
                        456,
                        789
                    ]
                },
                "type": {
                    "type": "string",
                    "description": "Type of custom information.",
                    "examples": [
                        "TED/TEF",
                        "Cash-in via invoice"
                    ]
                },
                "description": {
                    "type": "string",
                    "description": "Description of  custom information.",
                    "examples": [
                        "Invoce paid via internet banking"
                    ]
                },
                "name": {
                    "type": "string",
                    "description": "Name of custom information.",
                    "examples": [
                        "Invoice"
                    ]
                },
                "external_id": {
                    "type": "string",
                    "description": "External ID.",
                    "examples": [
                        "uuid"
                    ]
                },
                "origin": {
                    "type": "string",
                    "description": "Origin used in migrations.",
                    "examples": [
                        "STRIKER"
                    ]
                },
                "accounting_date": {
                    "type": "string",
                    "description": "Accounting date used in the migrations processes.",
                    "format": "date-time",
                    "examples": [
                        "2021-06-04T10:37:37.83Z"
                    ]
                }
            }
        },
        "installments": {
            "type": "object",
            "title": "Installments information",
            "description": "Reflects installments information.",
            "additionalProperties": false,
            "properties": {
                "number_of_installments": {
                    "type": "integer",
                    "description": "Number of installments in a payment.",
                    "examples": [
                        1,
                        10
                    ]
                },
                "deferred_months": {
                    "type": "integer",
                    "description": "Months that have been accepted in the negotiation.",
                    "examples": [
                        0,
                        1,
                        12
                    ]
                }
            }
        },
        "card": {
            "type": "object",
            "title": "Card object",
            "description": "Reflects card information on operations that utilize cards.",
            "additionalProperties": false,
            "required": [
                "tid",
                "id",
                "acquirer"
            ],
            "properties": {
                "tid": {
                    "type": "string",
                    "description": "Transaction ID provided by the acquirer layer.",
                    "examples": [
                        "123456789",
                        "987654321"
                    ]
                },
                "id": {
                    "type": "string",
                    "description": "Card UUID",
                    "examples": [
                        "b8bb8116-e7f4-46b2-b71b-bfb81ce9ce41",
                        "bbd3912a-eb71-4467-ad8f-2942ee4cc403"
                    ]
                },
                "acquirer": {
                    "type": "string",
                    "description": "Acquirer that processed the operation.",
                    "examples": [
                        "REDE"
                    ]
                }
            }
        }
    }
}
{
    "amount": 20.1,
    "authorization": {
        "id": 123,
        "code": "143726",
        "descriptor": "P2P",
        "operation_description": "CASH-IN",
        "processing_code": "007700",
        "account": {
            "id": 123
        },
        "card": {
            "tid": "123456789",
            "id": "b8bb8116-e7f4-46b2-b71b-bfb81ce9ce41",
            "acquirer": "REDE"
        },
        "custom": {
            "id": 123,
            "type": "TED/TEF",
            "description": "Invoce paid via internet banking",
            "name": "Invoice",
            "external_id": "uuid",
            "origin": "STRIKER",
            "accounting_date": "2021-06-04T10:37:37.83Z"
        }
    },
    "capture_id": 1374,
    "correlation_id": "2b190358-d339-4a69-b313-944e189c0a85",
    "event_date": "2021-06-04T10:37:37.83Z",
    "nsu": "12345",
    "tracking_id": "9cd6485a-5680-4df0-a1f1-507e21d3428c",
    "skip_timeline": true,
    "installments": {
        "number_of_installments": 1,
        "deferred_months": 0
    },
    "location": {
        "latitude": 24.12,
        "longitude": 24.12
    },
    "metadata": {
        "metadata": {
            "customer-data": {
                "any": "fields"
            }
        }
    }
}