Get invoices by reference ID

Nothing Found

Get invoices by reference ID

Returns all invoices for the given reference ID

Securitytilia_auth

Request

path Parameters

reference_id

required

string <= 36 characters

The reference ID of transactions to return

query Parameters

states	string Comma separated states in which to filter the response. By default, the response has no state filter applied. For example, a value of `states=FAILED,CANCELED` will return only invoices in those two states. Enum: "OPEN" "PROCESSING" "SUCCESS" "FAILED" "CANCELED"
invoice_types	string Default: "user_purchase,user_purchase_virtual" Comma separated list of transaction types to return. Enum: "user_purchase" "user_purchase_virtual" "payout_escrow" "payout_execute" "payout_reverse" "refund_invoice" "refund_line_item_invoice" "refund_invoice_virtual" "refund_line_item_invoice_virtual" "user_purchase_escrow" "user_purchase_escrow_virtual" "user_purchase_commit_escrow" "user_purchase_commit_escrow_virtual" "user_purchase_refund_escrow" "user_purchase_refund_escrow_virtual" "deposit" "token_purchase" "token_convert" "balance_transfer"
limit	number Default: 100 Maximum number of items to be retrieved
offset	number Default: 0 Offset to query at
sort_field	string Default: "updated" The field to sort the items by Enum: "created" "updated"
sort	string Default: "desc" Sort ascending or descending Enum: "asc" "desc"

Responses

200

Successfully retrieved invoices.

401

Unauthorized access.

500

Service unavailable or server error.

get/v2/invoice/reference/{reference_id}

Request samples

curl
Python
Go
JS
PHP

Response samples

application/json

{"status": "Success",
"message": null,
"codes": null,
"payload": {"total": 1,
"invoices": [{"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": null,
"currency": null,
"description": null,
"destination_account_id": null,
"destination_payment_method_id": null,
"destination_wallet_id": null,
"metadata": null,
"reference_id": null,
"reference_type": null,
"source_account_id": null,
"source_payment_method_id": null,
"source_wallet_id": null,
"subitem_id": null,
"subitem_type": null,
"tags": { }
}
],
"amount": 0
},
"property2": {"authorized_amount": 155,
"currency": "USD",
"payment_method_id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
"subitems": [{"amount": null,
"currency": null,
"description": null,
"destination_account_id": null,
"destination_payment_method_id": null,
"destination_wallet_id": null,
"metadata": null,
"reference_id": null,
"reference_type": null,
"source_account_id": null,
"source_payment_method_id": null,
"source_wallet_id": null,
"subitem_id": null,
"subitem_type": null,
"tags": { }
}
],
"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": null,
"currency": null,
"description": null,
"destination_account_id": null,
"destination_payment_method_id": null,
"destination_wallet_id": null,
"metadata": null,
"reference_id": null,
"reference_type": null,
"source_account_id": null,
"source_payment_method_id": null,
"source_wallet_id": null,
"subitem_id": null,
"subitem_type": null,
"tags": { }
}
],
"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
}
}
},
"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": null,
"currency": null,
"description": null,
"destination_account_id": null,
"destination_payment_method_id": null,
"destination_wallet_id": null,
"metadata": null,
"reference_id": null,
"reference_type": null,
"source_account_id": null,
"source_payment_method_id": null,
"source_wallet_id": null,
"subitem_id": null,
"subitem_type": null,
"tags": { }
}
],
"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
}
}
}
},
"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": null,
"created": null,
"integrator": null,
"namespace": null,
"resource_id": null,
"resource_type": null,
"status": null,
"tag": null,
"tag_id": null,
"updated": null
}
}
},
"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": 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"
}
}
}
]
}
}