id | ID of the Money Movement resource created. |
batch_id | Batch ID of the movement when it is part of a bulk transaction. |
external_id | ID provided by the client when initiating the Money Movement. |
mm_approval_id | Money Movement approval ID generated for a movement sent through approval. |
creator | user_id or API credential that created the Money Movement. |
type | Movement type selected from the supported Money Movement types, such as spei, fast_pay, r2p, cross_border, or r2p_spei. |
geo | Geography or corridor of the movement. |
status_state | Current state of the payment. |
status_code | Status code returned for states that need an additional reason. |
status_description | Verbose description of the current state, when applicable. |
source_id | Unique ID associated with the movement source, such as an account ID or a counterparty ID. |
source.account_type | Account type from the account type catalog when the source is expanded as an account. |
source.account_number | Account number for the source account. For Cobre Balances, this can be empty because the account is identified by metadata.cobre_tag. |
source.account.cobre_tag | Unique Cobre Tag identifier of the source Cobre Balance account. |
source.account.status | Connectivity status of the source account. |
source.account.provider_id | Provider ID linked to the source account. |
source.account.provider_name | Friendly name of the source account provider. |
source.account.currency | Currency in which the source account is denominated. |
source.counterparty.type | Counterparty type when the source is expanded as a counterparty. |
source.counterparty.account_number | Account number of the source counterparty, when available. |
source.counterparty.counterparty_fullname | Full name of the source counterparty, when available. |
source.counterparty.counterparty_id_type | Identification type of the source counterparty, when available. |
source.counterparty.counterparty_id_number | Identification number of the source counterparty, when available. |
source.counterparty.beneficiary_institution | Beneficiary institution code for the source counterparty, when available. |
destination_id | Unique ID associated with the movement destination, such as an account ID or a counterparty ID. |
destination.account_number | Account number for the destination account. |
destination.account_type | Account type from the account type catalog when the destination is expanded as an account. |
destination.account.cobre_tag | Unique Cobre Tag identifier of the destination Cobre Balance account. |
destination.account.status | Connectivity status of the destination account. |
destination.account.provider_id | Provider ID linked to the destination account. |
destination.account.provider_name | Friendly name of the destination account provider. |
destination.account.currency | Currency in which the destination account is denominated. |
destination.counterparty.type | Counterparty type when the destination is expanded as a counterparty. |
destination.counterparty.account_number | Account number of the destination counterparty, when available. |
destination.counterparty.counterparty_fullname | Full name of the destination counterparty, when available. |
destination.counterparty.counterparty_id_type | Identification type of the destination counterparty, when available. |
destination.counterparty.counterparty_id_number | Identification number of the destination counterparty, when available. |
destination.counterparty.beneficiary_institution | Beneficiary institution code for the destination counterparty, when available. |
currency | Currency of the movement. For cross-border movements, this can be represented as a currency pair. |
amount | Amount of the Money Movement. |
checker_approval | Flag indicating whether the Money Movement was sent for approval. |
metadata.description | Description for the Money Movement operation. |
metadata.reference | SPEI reference ID, up to 7 characters. |
metadata.cepUrl | URL of the CEP (Comprobante Electronico de Pago). |
metadata.trackingKey | Tracking key provided by the network. |
metadata.description_to_payer | Description intended for the payer of the Money Movement or payment link. |
metadata.valid_until | Validity period for a dynamic key or dynamic CLABE. Once expired, it cannot receive credits. |
metadata.pse_bank_code | Financial institution code used to pay an R2P PSE movement. |
metadata.description_to_beneficiary_account | Description that appears when the money is funded in the beneficiary account. |
r2p_methods | R2P rails available for the generated payment experience. |
metadata.redirect_url | URL that redirects the payer after the payment is made. |
metadata.payment_link | Payment link generated by the associated rail to complete the movement payment. |
metadata.cb.destination_description | Description that appears on the destination account for a cross-border movement. |
metadata.cb.forex_quote_id | FX quote ID used to create or lock the cross-border Money Movement. |
metadata.cb.forex_quote.fx_rate | Exchange rate applied to the currency pair. |
metadata.cb.forex_quote.source_amount | Amount of source currency to be transferred. |
metadata.cb.forex_quote.destination_amount | Destination amount after applying the exchange rate and deducting fees. |
metadata.r2p_rails | R2P rail used when generating the Money Movement. |
metadata.key_config | Option used to customize the dynamic key created. |
metadata.key_value | Alphanumeric value of the dynamic key, returned when the R2P rail is breb_key. |
metadata.qr_value | String that can be used to represent the QR of the dynamic key, returned when the R2P rail is breb_qr. |
metadata.virtual_account | Dynamic virtual CLABE delivered to the final user to complete an R2P SPEI payment. |
created_at | Date and time when the Money Movement was created. |
updated_at | Most recent update timestamp for the Money Movement. |