Using the Reconciliation service, you can get all orders or chargebacks for you account for a certain period.
You can get the information for the period, which is specified using the "date_from" and "date_to" parameters.
Those fields are mandatory for all Reconciliation API requests.
Order Reconciliation | Alt-Gate Order Reconciliation allows you to get the information about the orders and transactions for those orders.
Using current request, you can get the transaction_ids for the order_id, and the information about them.
POST https://reports.solidgate.com/api/v2/reconciliation/orders
POST https://reconciliation-alt.solidgate.com/api/v1/reconciliation/orders
orders.order_id
orders.transactions.id
{ "orders": [ { "order_id": "1564478491360recurring", "status": "refunded", "type": "recurring", "amount": 5200, "currency": "USD", "order_description": "test", "customer_account_id": "1234567", "customer_email": "kurt.Cruickshank.toster@gmail.com", "customer_first_name": null, "customer_last_name": null, "geo_country": "USA", "ip_address": "8.8.8.8", "error_code": null, "platform": "WEB", "fraudulent": true, "is_secured": false, "created_at": "2019-07-30 09:21:31", "updated_at": "2019-07-31 08:14:13", "transactions": [ { "id": "748b3f9eb69c6f6ac3be9102ba5a52cd5d414dd55cafb", "operation": "refund", "status": "success", "descriptor": "FAKE_PSP", "amount": 5200, "currency": "USD", "refund_reason": null, "refund_reason_code": "0019", "created_at": "2019-07-31 08:14:13", "updated_at": "2019-07-31 08:14:13", "finance_fee_amount": 15, "finance_fee_currency": "USD", "card": { "bank": null, "bin": null, "card_holder": null, "brand": null, "country": null, "number": null, "card_exp_month": null, "card_exp_year": null, "card_type": null } }, { "id": "748b3f9eb69c6f6ac3be9102ba5a52cd5d400c1be0638", "operation": "recurring", "status": "success", "descriptor": "FAKE_PSP", "amount": 5200, "currency": "USD", "refund_reason": null, "refund_reason_code": null, "created_at": "2019-07-30 09:21:31", "updated_at": "2019-07-30 09:21:33", "finance_fee_amount": 10, "finance_fee_currency": "USD", "card": { "bank": null, "bin": "471688", "card_holder": "diana goodman", "brand": "VISA", "country": "TUR", "number": "471688XXXXXX3303", "card_exp_month": "08", "card_exp_year": 2022, "card_type": "DEBIT" }, "billing_details": { "address": "11437 Woodmeadow Pkwy", "zip": "85001", "country": "USA", "city": "New Delhi", "state": "TX" } ] } ], "metadata": { "next_page_iterator": null } }
Chargeback Reconciliation allows you to get the information about the orders and chargebacks for those orders.
Using current request, you can get the chargebacks_id for the order_id, and the information about them.
POST https://reports.solidgate.com/api/v2/reconciliation/chargebacks
orders.order_id
orders.transactions.id
{ "orders": [ { "order_id": "267715846", "status": "approved", "type": "recurring", "amount": 690, "currency": "USD", "order_description": "VIP status", "customer_account_id": "76315607", "customer_email": "martin10_06@gmail.com", "customer_first_name": "Alexander", "customer_last_name": null, "geo_country": "PER", "ip_address": "132.191.0.111", "error_code": null, "platform": "WEB", "fraudulent": false, "is_secured": false, "created_at": "2019-06-28 12:28:03", "updated_at": "2019-06-28 12:28:05", "chargebacks": [ { "id": "148812", "created_at": "2019-07-12 10:50:25", "dispute_date": "2019-07-10", "settlement_date": "2019-07-10", "amount": 690, "reason_code": "10.4", "type": "1st_chb", "status": "in_progress", "reason_group": "Fraud", "reason_description": "Fraud – Card-Absent Environment", "currency": "USD", "finance_fee_amount": null, "finance_fee_currency": null, "flows": [ { "id": "414610", "amount": 690, "dispute_amount": null, "type": "1st_chb", "status": "in_progress", "date": "2019-07-10", "settlement_date": "2019-07-11", "created_at": "2019-07-12 10:50:25", "updated_at": "2019-07-12 10:50:25", "deadline_date": "2019-07-22", "arn_code": "24021219179008444371917", "currency": "USD", "finance_fee_amount": null, "finance_fee_currency": null } ] } ] } ], "metadata": { "next_page_iterator": null } }
Subscriptions Reconciliation allows you to get the information about the subscriptions, products and invoices for those subscriptions.
Using current request, you can get the subscription_id, product_id and the invoice_id and the information about them.
POST https://subscriptions.solidgate.com/api/v1/subscription/reconciliation
subscription.id
product.id
invoices.invoice_id.id
{ "subscriptions": { "75086028-8cfa-4c80-ac42-0a122aa40e64": { "id": "75086028-8cfa-4c80-ac42-0a122aa40e64", "status": "active", "started_at": "2020-12-08 12:01:03", "expired_at": "2020-12-08 12:02:03", "next_charge_at": "2020-12-08 12:02:03", "trial": false, "payment_type": "paypal-vault", "customer": { "customer_account_id": "1607428830474", "customer_email": "test@gmail.com" }, "product": { "id": "ce43b415-5522-4373-b026-a365462f9790", "name": "autotest_paypal-vault", "amount": 100, "currency": "USD", "trial": true, "payment_action": "auth_void", "trial_period": 1 }, "invoices": { "4022a203-ace8-415f-9ae7-730014fceb25": { "id": "4022a203-ace8-415f-9ae7-730014fceb25", "amount": 100, "status": "success", "created_at": "2020-12-08 12:01:03", "updated_at": "2020-12-08 12:01:03", "billing_period_started_at": "2020-12-08 12:01:03", "billing_period_ended_at": "2020-12-08 12:02:03", "subscription_term_number": 0, "orders": { "1607428830466widget": { "id": "1607428830466widget", "status": "refunded", "amount": 100, "created_at": "2020-12-08 12:01:03", "processed_at": "2020-12-08 12:01:02", "operation": "paypal-vault" } } } } }, "b5f32e30-b5d0-4135-af61-cd95bee9a23a": { "id": "b5f32e30-b5d0-4135-af61-cd95bee9a23a", "status": "active", "started_at": "2020-12-08 12:00:14", "expired_at": "2020-12-08 12:02:55", "cancelled_at": "2020-12-08 12:02:55", "next_charge_at": "2020-12-08 12:02:55", "trial": false, "cancel_code": "8.06", "cancel_message": "Cancellation by support", "payment_type": "paypal-vault", "customer": { "customer_account_id": "1607428713215", "customer_email": "test12345@gmail.com" }, "product": { "id": "a51ba9fd-3be1-4ef9-b00f-bb85157597f5", "name": "autotest_paypal-vault 2", "amount": 888, "currency": "USD", "trial": true, "payment_action": "charge_refund", "trial_period": 1 }, "invoices": { "311b34ca-b9af-40b6-8e75-89b5d5ec0dba": { "id": "311b34ca-b9af-40b6-8e75-89b5d5ec0dba", "amount": 888, "status": "success", "created_at": "2020-12-08 12:01:51", "updated_at": "2020-12-08 12:01:55", "billing_period_started_at": "2020-12-08 12:01:55", "billing_period_ended_at": "2020-12-08 12:02:55", "subscription_term_number": 1, "orders": { "86de0c5c-76d4-4f7c-9b93-e3dd73d89a79": { "id": "86de0c5c-76d4-4f7c-9b93-e3dd73d89a79", "status": "approved", "amount": 888, "created_at": "2020-12-08 12:01:51", "processed_at": "2020-12-08 12:01:55", "operation": "recurring" } } }, "29a7ace4-01f9-4399-b859-9256f3ad193b": { "id": "29a7ace4-01f9-4399-b859-9256f3ad193b", "amount": 444, "status": "success", "created_at": "2020-12-08 12:00:14", "updated_at": "2020-12-08 12:00:14", "billing_period_started_at": "2020-12-08 12:00:14", "billing_period_ended_at": "2020-12-08 12:01:14", "subscription_term_number": 0, "orders": { "1607428713208widget": { "id": "1607428713208widget", "status": "refunded", "amount": 444, "created_at": "2020-12-08 12:00:14", "processed_at": "2020-12-08 12:00:13", "operation": "paypal-vault" } } } } } }, "metadata": { "next_page_iterator": null } }
PayPal Dispute Reconciliation allows you to get the information about the disputes.
Using current request, you can get the dispute_id and the information about them.
POST https://reconciliation-alt.solidgate.com/api/v1/reconciliation/disputes
disputes.dispute_id
"disputes": [ { "dispute_id": "PP-D-85112454", "subscription_service_id": "a1239de9-q3gc-2156-4678-12rf178sdd1a", "order_id": "fdsyf9s8d69ds6gds96", "customer_account_id": "989742", "customer_email": "fairmail@yahoo.com", "subscription_product_id": "1a492e4b-29d8-324a-f4fad-8bfa6e44r4w6", "dispute_amount": 100, "dispute_currency": "USD", "reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED", "status": "WAITING_FOR_BUYER_RESPONSE", "dispute_life_cycle_stage": "INQUIRY", "dispute_channel": "INTERNAL", "seller_response_due_date": "2020-09-24 06:29:38", "dispute_create_time": "2020-08-15 08:05:01", "dispute_update_time": "2020-08-15 12:00:13", "created_at": "2020-08-23 12:05:28" } ]
Helpful links:
- Orders (cards) - https://dev.solidgate.com/developers/documentation/reconciliation/#Order_Reconciliation
- Orders (APM) - https://dev.solidgate.com/developers/documentation/reconciliation/#Alt-Gate_Order_Reconciliation
- ChargeBack (cards) - https://dev.solidgate.com/developers/documentation/reconciliation/#Chargeback_Reconciliation
- Dispute PayPal - https://dev.solidgate.com/developers/documentation/reconciliation/#Paypal_Dispute_Reconciliation
- Subscription - https://dev.solidgate.com/developers/documentation/reconciliation/#Subscriptions_Reconciliation