Retrieves details for the invoice specified by the invoice_id
URL parameter.
Successfully retrieved invoice.
Unauthorized access.
Invoice not found.
Service unavailable or server error.
{- "status": "Success",
- "message": null,
- "codes": null,
- "payload": {
- "invoice_id": "inv_2V2XDLW6zogChdShdFh8WKOhHii",
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "reference_type": "Acme order number",
- "reference_id": "8987749",
- "state": "FAILED",
- "description": "Digital product order",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "summary": {
- "currency": "string",
- "display_amount": "USD 1.55",
- "subtotal": {
- "currency": "string",
- "display_amount": "USD 1.55",
- "total_amount": 155
}, - "tax": {
- "currency": "string",
- "display_amount": "USD 1.55",
- "total_amount": 155
}, - "total_amount": 155
}, - "failure_code": "generic_error",
- "failure_reason": "an error occurred",
- "created": "string",
- "updated": "string",
- "payment_methods": {
- "property1": {
- "authorized_amount": 155,
- "currency": "USD",
- "payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "subitems": [
- {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": null,
- "created": null,
- "integrator": null,
- "namespace": null,
- "resource_id": null,
- "resource_type": null,
- "status": null,
- "tag": null,
- "tag_id": null,
- "updated": null
}
}
}
], - "amount": 0
}, - "property2": {
- "authorized_amount": 155,
- "currency": "USD",
- "payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "subitems": [
- {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": null,
- "created": null,
- "integrator": null,
- "namespace": null,
- "resource_id": null,
- "resource_type": null,
- "status": null,
- "tag": null,
- "tag_id": null,
- "updated": null
}
}
}
], - "amount": 0
}
}, - "line_items": {
- "property1": {
- "line_item_id": "12175ea1-5a52-4c8a-a027-0e7421ca613f",
- "amount": 155,
- "currency": "string",
- "transaction_type": "user_to_integrator",
- "product_sku": "SKU-123-A",
- "product_code": "code-123-A",
- "reference_type": "Acme catalog ID",
- "reference_id": "7245480",
- "description": "In-game digital bundle",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "sort_order": 0,
- "subitems": [
- {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": null,
- "created": null,
- "integrator": null,
- "namespace": null,
- "resource_id": null,
- "resource_type": null,
- "status": null,
- "tag": null,
- "tag_id": null,
- "updated": null
}
}
}
], - "tags": {
- "<tag_id>": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
}
}, - "property2": {
- "line_item_id": "12175ea1-5a52-4c8a-a027-0e7421ca613f",
- "amount": 155,
- "currency": "string",
- "transaction_type": "user_to_integrator",
- "product_sku": "SKU-123-A",
- "product_code": "code-123-A",
- "reference_type": "Acme catalog ID",
- "reference_id": "7245480",
- "description": "In-game digital bundle",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "sort_order": 0,
- "subitems": [
- {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": null,
- "created": null,
- "integrator": null,
- "namespace": null,
- "resource_id": null,
- "resource_type": null,
- "status": null,
- "tag": null,
- "tag_id": null,
- "updated": null
}
}
}
], - "tags": {
- "<tag_id>": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
}
}
}, - "subitems": {
- "property1": {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
}
}, - "property2": {
- "amount": 155,
- "currency": "string",
- "description": "In-game digital bundle",
- "destination_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "destination_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "destination_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "metadata": {
- "key1": {
- "key2": 3
}
}, - "reference_id": "0e8ed55b-38b0-470b-8aed-10aa9d8ceb95",
- "reference_type": "invoicing.invoice_line_item_v2.line_item_id",
- "source_account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "source_payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "source_wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "subitem_id": "f8adbba4-6909-4e2f-949c-60623c8c9d4b",
- "subitem_type": "user_recipient_virtual",
- "tags": {
- "<tag_id>": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
}
}
}, - "tags": {
- "<tag_id>": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
}
}
}