Recover Payment Object Properties

4 min

detailed table views of all required and available properties to be sent to the recover payments api docid\ oylr8swr hn9dqzoscpcw customer properties property required example description id \true\ 11223344 the internal identifier of the customer from your subscription management platform psp id false cus 12345 the internal identifier of the customer from your payment service provider created at false 2023 09 25t03 57 26z timestamp of when the customer was created in your subscription management platform postal code false 94530 the postal code of the customer subscription properties property required example description id \true\ sub 12345 the internal identifier from your subscription management platform used to designate the subscription start date \t\ \rue\ 2023 09 25t03 57 26z timestamp of when the subscription started in your subscription management platform end date false 2024 09 25t03 57 26z timestamp of when the subscription ended/will end in your subscription managment platform discounted or free period false true/false boolean boolean to designate a free trial or discounted billing product id false sku 1234 the unique identifier of the product billing period false day, week, month, year the subscription billing period must be set to one of the specified values or absent billing frequency false 1 the number of payments per billing period must be a positive integer or absent invoice properties property required example description id \true\ inv 12345 the internal identifier of the invoice from your subscription management platform created at \true\ 2023 09 25t03 57 26z timestamp of when the invoice was created transaction properties provided as an array of transactions at least one transaction is required if your retry strategy includes multiple payment methods, list each of them here rather than sending an additional event for each transaction property required example description id \true\ ts 12345 the internal identifier of the transaction from your subscription management platform psp id \true\ ts 12345 the internal identifier of the transaction from your payment service provider psp \true\ stripe, braintree, worldpay, recharge, recurly, ayden the name of the psp the transaction originated from must be one of the values acquirer country \true\ us the country in which the payment was processed and acquired in amount \true\ 10 00 the amount of the transaction, as a float currency \true\ usd the currency of the transaction in iso standard format funding source \true\ credit, debit, mixed, paypal, prepaid, uncategorized, unknown the account type funding the card must be one of the specified values payment method id \true\ pm 12345 the id from the psp of the payment method attempted psp transaction created at \true\ 2023 09 25t03 57 26z timestamp of when the transaction was created on the psp scheme \true\ visa network of the payment card (visa, mastercard, etc ) success \true\ true/false (boolean) boolean to represent if the transaction was successfully processed outcome raw response message \true\ insufficient funds the issuer approval or decline message provided in the authorization response outcome psp response message false the customer has insufficient funds the response description provided by the payment processor outcome processor response code false 2000 the response code returned provided by the payment processor outcome network status false psp block additional network data returned by certain payment processors (if applicable) outcome response type false hard decline category of decline code (soft decline, hard decline) network transaction id false pcqvzwbga0912 the original transaction id from the network required for worldpay mid false 8224137 the mid (merchant identification number) used to process a transaction with the psp required for worldpay integrations reporting group false pepsi the identifier used to categorize the transaction data commonly used for reporting and analysis, identifying business units and branches, currencies, etc billing postal code false 94530 the customer's billing address postal code auth false true/false (boolean) boolean to represent if this is a pre authorization or final capture bin false 112233 the 6 digit bank identification number of the payment card used captured false true/false (boolean) boolean to represent if the payment has been captured issuer country false us the country in which the payment card was issued refunded false true/false (boolean) boolean to represent if the payment has been refunded enhanced data level 2 false level 2 processing typically includes extra details such as customer code (often a purchase order number), sales tax amount, and a merchant's tax id the inclusion of this data often qualifies the merchant for lower processing fees it's particularly beneficial for corporate or government transactions enhanced data level 3 false level 3 processing includes line item details such as item descriptions, quantities, unit prices, and product codes this level of detail is similar to what's found on an itemized invoice level 3 processing is typically used for large corporate and government transactions and can lead to even lower interchange rates due to the reduced risk and enhanced information provided