Transactions
In this report, you can find all payments performed and evolution of the transactions lifecycle.
Sample files
You can download file examples in json or in csv format.
Data structure
info
All date are in ISO UTC format
| Field in JSON file | Field in CSV file | Type | Description | Example |
|---|---|---|---|---|
| id | TRANSACTION_ID | string | Purse unique transaction identifier | 74ed2728-ec12-45b3-8e59-2da09affd66e |
| partner | PARTNER | enum | Name of the Partner | BRAINTREE |
| entity_id | ENTITY_ID | string | Purse merchant id | 21d8373b-987f-e9e6-6294-983deab36e9a |
| transaction_detail.session_id | SESSION_ID | string | Purse unique session identifier | 53d24bd2-a781-44f8-8cb4-1927424b90bb |
| transaction_detail.partner_id | PARTNER_TRANSACTION_ID | string | Partner transaction identifier. Uniqueness cannot be guaranteed by Purse | 123abc |
| transaction_detail.partner_original_id | PARTNER_ORIGINAL_TRANSACTION_ID | string | Partner unique identifier of the original transaction in case of a refund or a duplication | xgt9528r41 |
| transaction_detail.partner_technical_id | PARTNER_TECHNICAL_TRANSACTION_ID | string | Transaction identifier provided by the partner for debug / tracking purpose | LNVFDH8766 |
| transaction_detail.type | TRANSACTION_TYPE | enum | Transaction type | WITHDRAWALS_AND_DEBITS_CATEGORY |
| transaction_detail.amount | TRANSACTION_AMOUNT | number | Amount | 1000 |
| transaction_detail.partner_status | PARTNER_TRANSACTION_STATUS | string | Partner status of transaction | WAITING_AUTHORISATION |
| transaction_detail.status_code | TRANSACTION_STATUS_CODE | enum | Transaction status code | SUCCEEDED |
| transaction_detail.date | TRANSACTION_DATE | date | Date of transaction (creation) | 2022-02-16T00:00:00.000Z |
| transaction_detail.currency | TRANSACTION_CURRENCY | string | Currency | EUR |
| transaction_detail.label | TRANSACTION_LABEL | string | Additional information set by the merchant and returned by the partner | |
| transaction_detail.partner_nsu | TRANSACTION_PARTNER_NSU | string | Identification number of sale transactions using cards (Unique Sequence Number) | 000000000000200 |
| customer.reference | CUSTOMER_REFERENCE | string | Customer identifier. See Customer Reference | y15txj98 |
| customer.company_name | CUSTOMER_COMPANY_NAME | string | Customer company (for B2B). See Customer Company Name | Purse |
| customer.first_name | CUSTOMER_FIRST_NAME | string | Customer first name. See Customer First Name | John |
| customer.last_name | CUSTOMER_LAST_NAME | string | Customer last name. See Customer Last Name | Doe |
| customer.ip | CUSTOMER_IP | string | Customer IP address. See Customer IP | 128.1.2.3 |
| customer.ip_country | CUSTOMER_IP_COUNTRY | string | Customer IP address country | FR |
| customer.label | CUSTOMER_LABEL | string | Information about the user who paid | |
| customer.billing_address.first_name | CUSTOMER_BILLING_FIRST_NAME | string | Customer billing first name. See Customer Billing Address | Eva |
| customer.billing_address.last_name | CUSTOMER_BILLING_LAST_NAME | string | Customer billing last name. See Customer Billing Address | Pasteur |
| customer.billing_address.address_lines[0] | CUSTOMER_BILLING_ADDRESS_LINE1 | string | Customer billing address first line. See Customer Billing Address | Av. Revolución 1676 |
| customer.billing_address.address_lines[1] | CUSTOMER_BILLING_ADDRESS_LINE2 | string | Customer billing address second line. See Customer Billing Address | |
| customer.billing_address.address_lines[2] | CUSTOMER_BILLING_ADDRESS_LINE3 | string | Customer billing address third line. See Customer Billing Address | |
| customer.billing_address.city | CUSTOMER_BILLING_CITY | string | Customer billing city. See Customer Billing Address | Tijuana |
| customer.billing_address.postal_code | CUSTOMER_BILLING_POSTAL_CODE | string | Customer billing postal code. See Customer Billing Address | 22000 |
| customer.billing_address.country_code | CUSTOMER_BILLING_COUNTRY_CODE | string | Customer billing country (ISO code). See Customer Billing Address | MX |
| customer.billing_address.province_code | CUSTOMER_BILLING_PROVINCE_CODE | string | Customer billing province code. See Customer Billing Address | MX-BCN |
| customer.billing_address.email | CUSTOMER_BILLING_EMAIL | string | Customer billing email. See Customer Billing Address | [email protected] |
| customer.billing_address.phone | CUSTOMER_BILLING_PHONE | string | Customer phone. See Customer Billing Address | +526645951538 |
| customer.billing_address.mobile_phone | CUSTOMER_BILLING_MOBILE_PHONE | string | Customer mobile phone. See Customer Billing Address | +33601010101 |
| customer.account.creation_date_time | CUSTOMER_ACCOUNT_CREATION_DATE_TIME | date | Customer account creation date. See Account Creation Date Time | 2020-11-16T00:00:00.000Z |
| customer.account.purchase_count_last_day | CUSTOMER_ACCOUNT_PURCHASE_COUNT_LAST_DAY | number | Number of purchases made by the customer in the last day. See Account Purchase count | 0 |
| customer.account.purchase_count_last_six_months | CUSTOMER_ACCOUNT_PURCHASE_COUNT_LAST_SIX_MONTHS | number | Number of purchases made by the customer in the last 6 months. See Account Purchase count | 1 |
| customer.account.purchase_count_last_year | CUSTOMER_ACCOUNT_PURCHASE_COUNT_LAST_YEAR | number | Number of purchases made by the customer in the last year. See Customer Purchase count | 3 |
| authentication_date | AUTHENTICATION_DATE | date | Authentication date | 2021-08-11T00:00:00.000Z |
| bank.authorization_date | BANK_AUTHORIZATION_DATE | date | Authorization date | 2021-08-11T01:00:00.000Z |
| bank.authorization_id | BANK_AUTHORIZATION_ID | string | Authorization id | 3fcaa9 |
| bank.authorization_result | BANK_AUTHORIZATION_RESULT | enum | Authorization result returned by the bank | TRANSACTION_APPROVED_SUCCESS |
| bank.code | BANK_CODE | string | Bank code | 10765 |
| bank.iban | IBAN | string | Iban | FR1430001019010000Z67067032 |
| cancel_date | CANCEL_DATE | date | Cancel date (only if transaction was canceled) | 2021-08-11T01:00:00.000Z |
| capture_date | CAPTURE_DATE | date | Capture date (only if capture succeeded) | 2021-08-11T01:00:00.000Z |
| card.type | CARD_TYPE | string | Card sub network | G1 |
| card.network | CARD_NETWORK | string | Card network (mastercard, visa ...) | VISA |
| card.country | CARD_COUNTRY | string | Card country (ISO) | FR |
| card.category | CARD_CATEGORY | string | Category of the card | CREDIT |
| card.type_complementary_info | CARD_TYPE_COMPLEMENTARY_INFO | string | Complementary information about the card. Blank if the partner doesn't return the information in a single field | |
| card.bin | CARD_BIN | string | Bank identification number | 123456XXXXXX1234 |
| card.automatic_authorization | CARD_AUTOMATIC_AUTHORIZATION | enum (YES,NO) | Yes if card always needs authorization | YES |
| card.exp_date | CARD_EXP_DATE | date (yyyy-MM) | Card expiration date | 2022-10 |
| card.owner_name | CARD_OWNER_NAME | string | Card owner name | |
| card.partner_wallet_token | CARD_PARTNER_WALLET_TOKEN | string | Wallet token provided by the partner | 16ef4cd4872b48b7bd008bd41f242e3e |
| card.virtual_card_provider | CARD_VIRTUAL_CARD_PROVIDER | string | Name of the virtual card provider | |
| charge_back | CHARGE_BACK | enum (YES, NO) | Indicates if this transaction was charged back | NO |
| contract_vad | CONTRACT_VAD | string | VAD contract PSP identification. The identifier is partner specific | 0535530 |
| merchant.legal_identifier | MERCHANT_LEGAL_ID | string | Legal merchant identifier | |
| merchant.partner_id | MERCHANT_PARTNER_ID | string | Identifier of the merchant provided by the partner | o9ksbh10 |
| order.reference | ORDER_REFERENCE | string | Order identifier. See Order Reference | FRA_123 |
| order.amount | ORDER_AMOUNT | number | Order amount. See Order Amount | 123.76 |
| order.currency_code | ORDER_CURRENCY_CODE | string | Order currency. See Order Currency Code | EUR |
| order.additional_attributes[0] | ORDER_ADDITIONAL_ATTRIBUTE1 | string | Additional attributes sent by the merchant. See Additional Attribute | |
| order.additional_attributes[1] | ORDER_ADDITIONAL_ATTRIBUTE2 | string | Additional attributes sent by the merchant. See Additional Attribute | |
| order.additional_attributes[2] | ORDER_ADDITIONAL_ATTRIBUTE3 | string | Additional attributes sent by the merchant. See Additional Attribute | |
| payment.method | PAYMENT_METHOD | string | Payment method | CARD |
| payment.mode | PAYMENT_MODE | enum | Temporality of the payment if provided by the Partner | N_TIMES |
| payment.partner_certificate_id | PARTNER_PAYMENT_CERTIFICATE_ID | string | Certificate ID of the payment provided by the partner | 6ed7b71c023a20adbadf9a2e2c58cd4321f63123 |
| payment.partner_notification_status | PARTNER_NOTIFICATION_STATUS | string | Status of the notification sent from the partner to the merchant configured URL | FAILED |
| payment.partner_subscription_id | PARTNER_PAYMENT_SUBSCRIPTION_ID | string | Token provided by the partner referencing an account serial | 5fa8d3dede8f4c219c4652dfabe2bf55-20191106ANav0o |
| refund_date | REFUND_DATE | date | Some partners provide the date on which the payment was refunded | 2022-02-16T00:00:00.000Z |
| risk.partner_code | RISK_PARTNER_CODE | string | Risk code provided by the partner (Not converted) | 00 |
| risk.partner_message | RISK_PARTNER_MESSAGE | string | Message attached to risk partner code | |
| settle_value_date | SETTLE_VALUE_DATE | date | Settlement value date (if reconciled by the partner). See Settlement documentation | 2022-02-16T00:00:00.000Z |
| settlement_status | SETTLEMENT_STATUS | enum | Settlement status | MATCH_SUCCESS |
| shipping_address.first_name | SHIPPING_ADDRESS_FIRST_NAME | string | Shipping address first name. See Order Shipping Address | Eva |
| shipping_address.last_name | SHIPPING_ADDRESS_LAST_NAME | string | Shipping address last name. See Order Shipping Address | Pasteur |
| shipping_address.address_lines[0] | SHIPPING_ADDRESS_LINE1 | string | Shipping address first line. See Order Shipping Address | Av. Revolución 1676 |
| shipping_address.address_lines[1] | SHIPPING_ADDRESS_LINE2 | string | Shipping address second line. See Order Shipping Address | |
| shipping_address.address_lines[2] | SHIPPING_ADDRESS_LINE3 | string | Shipping address third line. See Order Shipping Address | |
| shipping_address.city | SHIPPING_ADDRESS_CITY | string | Shipping address city. See Order Shipping Address | Tijuana |
| shipping_address.postal_code | SHIPPING_ADDRESS_POSTAL_CODE | string | Shipping address postal code. See Order Shipping Address | 22000 |
| shipping_address.country_code | SHIPPING_ADDRESS_COUNTRY_CODE | string | Shipping address country code. See Order Shipping Address | MX |
| shipping_address.province_code | SHIPPING_ADDRESS_PROVINCE_CODE | string | Shipping address province code. See Order Shipping Address | MX-BCN |
| shipping_address.phone | SHIPPING_ADDRESS_PHONE | string | Shipping address phone. See Order Shipping Address | +526645951538 |
| partner_shop_id | PARTNER_SHOP_ID | string | Shop identifier set with the partner (if merchant has multiple web point of sale) | 1237yrbh |
| partner_shop_name | PARTNER_SHOP_NAME | string | Shop name set with the partner (if merchant has multiple web point of sale) | Mon Shop |
| three_dsecure.processed | THREE_DS_PROCESSED | enum (YES, NO) | The payment was submitted to 3D Secure | YES |
| three_dsecure.response | THREE_DS_RESPONSE | enum | 3D secure authentication result mapped to Purse values | SUCCESS |
| three_dsecure.liability_shift | THREE_DS_LIABILITY_SHIFT | enum (YES, NO, UNKNOWN) | Payment is guaranteed by 3D Secure | YES |
| three_dsecure.verification_id | THREE_DS_VERIFICATION_ID | string | 3D secure verification ID (such as CAVV) | Q**************************= |
| partner_ticket_number | PARTNER_TICKET_NUMBER | string | Ticket identifier provided by partner (for Web POS only) | 1235 |