Retrieve Authorization

Request

ENDPOINT

/prepaid/card/(card_key)/authorization/(authorization_key)

METHOD

GET

Response

STATUS

200

Response Body

{
    "authorization_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
    "merchant_currency_code": "BRL",
    "original_merchant_amount": 25.32,
    "billing_currency_code": "BRL",
    "original_billing_amount": 25.32,
    "merchant_amount": 25.32,
    "iof_amount": 0,
    "billing_amount": 25.32,
    "processing_datetime": "2023-07-24T12:00:00.000Z",
    "captured_amount": 25.32,
    "authorization_status": "completed",
    "card": {
        "card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
        "account_key": "595e08f0-da4e-40f7-8db4-f9a25c829818",
        "type": "virtual",
        "card_name": "ecommerce sample",
        "printed_name": "Aurora Catarina",
        "status": "active",
        "brand": "visa",
        "bin": "123456",
        "last_four_digits": "5695"
    },
    "balance_transactions": [
        {
            "balance_transaction_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
            "balance_transaction_type": "debit",
            "account_transaction_key": "595e08f0-da4e-40f7-8db4-f9a25c820000",
            "account_key": "595e08f0-da4e-40f7-8db4-f9a25c829818",
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-01-10T13:45:52.000Z",
            "balance_transaction_status": "transacted",
            "transacted_amount": 25.32,
        }
    ],
    "authorization_requests": [
        {
            "authorization_request_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
            "authorization_code": "473890",
            "nsu": "123456",
            "acquirer_reference_number": "12312423",
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-01-10T13:45:52.000Z",
            "number_of_installments": 1,
            "authorization_request_type": "authorization",
            "authorization_request_response": "authorized"
        }
    ],
    "authorization_events": [
        {
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-07-24T12:00:00.000Z",
            "authorization_event_type": "authorization"
        }
    ]
}

Authorization Object

Field	Type	Description
authorization_key	string	Authorization unique identifier
merchant_currency_code	string	The currency used by the merchant - ISO 4217-alpha
original_merchant_amount	decimal	Original amount of the transaction in the merchant currency
billing_currency_code	string	The cardholder's billing currency - ISO 4217-alpha
original_billing_amount	decimal	Original amount in cardholder's billing currency
merchant_amount	decimal	Sum of the current authorized amount in the merchant's currency, from all authorization requests
iof_amount	decimal	Sum of the IOF amount for international authorizations on cardholder's billing currency
billing_amount	decimal	Sum of the current authorized amount in the cardholder's billing currency, from all authorization requests
processing_datetime	datetime UTC	Time of the authorization creation
captured_amount	decimal	Sum of the total value captured
authorization_status	enumerator	Enumerator of Authorization Status
card	object	Object Card
balance_transactions	list of objects	Balance Transaction Object
authorization_requests	list of objects	Authorization Request Object
authorization_events	list of objects	Authorization Event Object

Card Object

Field	Type	Description
card_key	string	Card unique identifier
account_key	string	Card linked account unique identifier
type	string	Card type
card_name	string	Card name
printed_name	string	Name printed on card
status	string	Current card status
brand	string	Card network name
bin	string	Card BIN
last_four_digits	string	Card's last four digits

Balance Transaction Object

The Balance Transaction object represents any movement in the cardholder's account balance. They can be debit transactions (reducing the account balance), or they can be credit transactions (increasing the account balance).

Field	Type	Description
balance_transaction_key	string	Balance transaction unique identifier
balance_transaction_type	enumerator	Possible values (credit, debit)
account_key	string	Card linked account unique identifier
merchant_currency_code	string	The currency used by the merchant - ISO 4217-alpha
merchant_amount	decimal	Amount of the transaction in the merchant currency
billing_currency_code	string	The cardholder's billing currency - ISO 4217-alpha
billing_amount	decimal	Amount of the transaction in the cardholder's billing currency
processing_datetime	datetime	Transaction's processing and creation datetime
balance_transaction_status	enumerator	The status of the balance transaction: pending (pending_transaction_execution), partially transacted (partially_transacted) or transacted (transacted)
transacted_amount	decimal	Total amount that was successfully debited/credited from cardholder's account balance

Authorization Request Object

Detailed in Authorization Request

Authorization Event Object

The Authorization Event object represents the events that occur with an Authorization. See Use Cases.

Field	Type	Description
merchant_currency_code	string	The currency used by the merchant - ISO 4217-alpha
merchant_amount	decimal	Amount of the event in the merchant currency
billing_currency_code	string	The cardholder's billing currency - ISO 4217-alpha
billing_amount	decimal	mount of the event in the cardholder's billing currency
processing_datetime	datetime	Event's processing datetime
authorization_event_type	enumerator	Authorization Event Types

Authorization Status

Status	Description
pending	Authorization request was authorized and no capture or reversal events were processed
unauthorized	Authorization request was not approved
completed	Authorization with at least one captured value (equal to, less than, or greater than the total authorized amount)
reversed	Authorization was voided in full or expired without capture

Authorization Event Types

Type	Description
authorization	An authorization request was processed
incremental_authorization	An incremental authorization request was processed
authorization_reversal	An authorization was fully reversed
partial_authorization_reversal	An authorization was partially reversed
authorization_expiration	The uncaptured amount of an authorization was expired and reversed to the cardholder's account balance
capture	An amount was captured for the authorization
refund	The captured amount was fully refunded for the authorization
partial_refund	The captured amount was partially refunded for the authorization