{"title":"Payment Instrument Report","category":"default","creationDate":1627458960,"content":"

The Payment Instrument Report shows all the payment instruments in your platform, including details about the card and its status.<\/p>\n

You can generate<\/a> a Payment Instrument Report automatically based on a schedule, or manually for a specific day or consecutive days in your Customer Area<\/a>.<\/p>\n

Sample<\/h2>\n

Download a sample BalancePlatform Payment Instrument Report<\/a> for examples of the included data.
\nBased on your platform settings, the report you generate in your account can contain additional data or columns that are not included in the sample report.<\/p>\n

Report structure<\/h2>\n

Every row in the Payment Instrument Report represents one payment instrument with its current status at the time the report is generated.<\/p>\n

The first two rows of the report contain the following information:<\/p>\n

BalancePlatform Payment Instrument Report on\npayment instruments<\/code><\/pre>\n
The header row is in the third row and contains the following information.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
#<\/th>\nColumn<\/th>\nData type<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nBalance Platform<\/td>\nUnicode Text<\/td>\nName of your Balance Platform account.<\/td>\n<\/tr>\n
2<\/td>\nPayment Instrument id<\/td>\nUnicode text<\/td>\nUnique identifier of the payment instrument.<\/td>\n<\/tr>\n
3<\/td>\nPayment instrument external reference<\/td>\nUnicode text<\/td>\nYour reference to the payment instrument.<\/td>\n<\/tr>\n
4<\/td>\nPayment instrument description<\/td>\nUnicode text<\/td>\nThe description provided for the payment instrument in POST \/paymentInstruments<\/a>.<\/td>\n<\/tr>\n
5<\/td>\nForm factor<\/td>\nEnum<\/td>\nThe form factor of the card. Possible values: virtual<\/strong><\/span>, physical<\/strong><\/span>.<\/td>\n<\/tr>\n
6<\/td>\nCreated date<\/td>\nDate field<\/td>\nThe date of the payment.<\/td>\n<\/tr>\n
7<\/td>\nCardholder name<\/td>\nUnicode text<\/td>\nThe name of the cardholder.<\/td>\n<\/tr>\n
8<\/td>\nFirst six digits of the PAN<\/td>\nFixed point number<\/td>\nThe first six digits of the Primary Account Number.<\/td>\n<\/tr>\n
9<\/td>\nLast four digits of the PAN<\/td>\nFixed point number<\/td>\nThe last four digits of the Primary Account Number.<\/td>\n<\/tr>\n
10<\/td>\nSequence number<\/td>\nFixed point number<\/td>\nIndicates the logical order in which the same PAN has been issued.<\/td>\n<\/tr>\n
11<\/td>\nExpiry date<\/td>\nDate field<\/td>\nThe date when the payment instrument expires.<\/td>\n<\/tr>\n
12<\/td>\nStatus<\/td>\nEnum<\/td>\nThe status of the payment instrument. Possible values: active<\/strong><\/span>, inactive<\/strong><\/span>, suspended<\/strong><\/span>, closed<\/strong><\/span>.<\/td>\n<\/tr>\n
13<\/td>\nStatus reason<\/td>\nUnicode text<\/td>\nThe detailed explanation for the status of the payment instrument. Possible values:  lost<\/strong><\/span>, stolen<\/strong><\/span>, damaged<\/strong><\/span>, suspectedFraud<\/strong><\/span>, other<\/strong><\/span>.<\/td>\n<\/tr>\n
14<\/td>\nIssuing country code<\/td>\nAlpha text<\/td>\nLocation where the payment instrument is issued. Its value is a two-character ISO 3166-1 alpha-2<\/a> code.<\/td>\n<\/tr>\n
15<\/td>\nCurrency<\/td>\nAlpha Text
(3-character limit)<\/td>\n		The currency of the card. Its value is a three-character ISO 4217 currency code.<\/td>\n<\/tr>\n
16<\/td>\nBrand variant<\/td>\nUnicode text<\/td>\nThe brand variant for the payment instrument. For example: mcdebit<\/strong><\/span>, visaprepaid<\/strong><\/span>.<\/td>\n<\/tr>\n
17<\/td>\nAccount holder id<\/td>\nUnicode text<\/td>\nUnique identifier of the balance account's account holder associated with the payment instrument.<\/td>\n<\/tr>\n
18<\/td>\nAccount holder reference<\/td>\nUnicode text<\/td>\nYour reference for the account holder.<\/td>\n<\/tr>\n
19<\/td>\nAccount holder description<\/td>\nUnicode text<\/td>\nYour description for the account holder.<\/td>\n<\/tr>\n
20<\/td>\nBalance account id<\/td>\nUnicode text<\/td>\nThe unique identifier of the balance account.<\/td>\n<\/tr>\n
21<\/td>\nBalance account reference<\/td>\nUnicode text<\/td>\nYour reference to the balance account.<\/td>\n<\/tr>\n
22<\/td>\nBalance account description<\/td>\nUnicode text<\/td>\nYour description for the balance account.<\/td>\n<\/tr>\n
23<\/td>\nReserved1<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
24<\/td>\nReserved2<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
25<\/td>\nReserved3<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
26<\/td>\nReserved4<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
27<\/td>\nReserved5<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
28<\/td>\nReserved6<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
29<\/td>\nReserved7<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
30<\/td>\nReserved8<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
31<\/td>\nReserved9<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n
32<\/td>\nReserved10<\/td>\n-<\/td>\nReserved for future enhancements<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/issuing\/report-types\/payment-instrument-report","articleFields":{"description":"Get an overview of all payment instruments in your platform.","feedback_component":true,"last_edit_on":"01-03-2022 15:23","parameters":{"directoryPath":"\/issuing"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/issuing\/report-types\/payment-instrument-report","title":"Payment Instrument Report","content":"The Payment Instrument Report shows all the payment instruments in your platform, including details about the card and its status.\nYou can generate a Payment Instrument Report automatically based on a schedule, or manually for a specific day or consecutive days in your Customer Area.\nSample\nDownload a sample BalancePlatform Payment Instrument Report for examples of the included data.\nBased on your platform settings, the report you generate in your account can contain additional data or columns that are not included in the sample report.\nReport structure\nEvery row in the Payment Instrument Report represents one payment instrument with its current status at the time the report is generated.\nThe first two rows of the report contain the following information:\nBalancePlatform Payment Instrument Report on\npayment instruments\nThe header row is in the third row and contains the following information.\n\n\n\n#\nColumn\nData type\nDescription\n\n\n\n\n1\nBalance Platform\nUnicode Text\nName of your Balance Platform account.\n\n\n2\nPayment Instrument id\nUnicode text\nUnique identifier of the payment instrument.\n\n\n3\nPayment instrument external reference\nUnicode text\nYour reference to the payment instrument.\n\n\n4\nPayment instrument description\nUnicode text\nThe description provided for the payment instrument in POST \/paymentInstruments.\n\n\n5\nForm factor\nEnum\nThe form factor of the card. Possible values: virtual, physical.\n\n\n6\nCreated date\nDate field\nThe date of the payment.\n\n\n7\nCardholder name\nUnicode text\nThe name of the cardholder.\n\n\n8\nFirst six digits of the PAN\nFixed point number\nThe first six digits of the Primary Account Number.\n\n\n9\nLast four digits of the PAN\nFixed point number\nThe last four digits of the Primary Account Number.\n\n\n10\nSequence number\nFixed point number\nIndicates the logical order in which the same PAN has been issued.\n\n\n11\nExpiry date\nDate field\nThe date when the payment instrument expires.\n\n\n12\nStatus\nEnum\nThe status of the payment instrument. Possible values: active, inactive, suspended, closed.\n\n\n13\nStatus reason\nUnicode text\nThe detailed explanation for the status of the payment instrument. Possible values:  lost, stolen, damaged, suspectedFraud, other.\n\n\n14\nIssuing country code\nAlpha text\nLocation where the payment instrument is issued. Its value is a two-character ISO 3166-1 alpha-2 code.\n\n\n15\nCurrency\nAlpha Text(3-character limit)\nThe currency of the card. Its value is a three-character ISO 4217 currency code.\n\n\n16\nBrand variant\nUnicode text\nThe brand variant for the payment instrument. For example: mcdebit, visaprepaid.\n\n\n17\nAccount holder id\nUnicode text\nUnique identifier of the balance account's account holder associated with the payment instrument.\n\n\n18\nAccount holder reference\nUnicode text\nYour reference for the account holder.\n\n\n19\nAccount holder description\nUnicode text\nYour description for the account holder.\n\n\n20\nBalance account id\nUnicode text\nThe unique identifier of the balance account.\n\n\n21\nBalance account reference\nUnicode text\nYour reference to the balance account.\n\n\n22\nBalance account description\nUnicode text\nYour description for the balance account.\n\n\n23\nReserved1\n-\nReserved for future enhancements\n\n\n24\nReserved2\n-\nReserved for future enhancements\n\n\n25\nReserved3\n-\nReserved for future enhancements\n\n\n26\nReserved4\n-\nReserved for future enhancements\n\n\n27\nReserved5\n-\nReserved for future enhancements\n\n\n28\nReserved6\n-\nReserved for future enhancements\n\n\n29\nReserved7\n-\nReserved for future enhancements\n\n\n30\nReserved8\n-\nReserved for future enhancements\n\n\n31\nReserved9\n-\nReserved for future enhancements\n\n\n32\nReserved10\n-\nReserved for future enhancements\n\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Issuing","lvl2":"Report types","lvl3":"Payment Instrument Report"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/issuing","lvl2":"https:\/\/docs.adyen.com\/pt\/issuing\/report-types","lvl3":"\/pt\/issuing\/report-types\/payment-instrument-report"},"levels":4,"category":"Issuing","category_color":"green","tags":["Payment","Instrument","Report"]},"articleFiles":{"SAMPLE_payment_instrument_report_2022_01_01.csv":"
SAMPLE_payment_instrument_report_2022_01_01.csv<\/p>"}}